Open topic with navigation

# AgentRead

Allows you to view agent details.

## Example

    http://12.3.4.56:9000/action=AgentRead&UserName=Administrator&AgentName=Global+Warming

This action uses port `9000` to request the details of the `Global Warming` agent for the `Administrator` user from HPE IDOL Server, which is situated on a machine with the IP address `12.3.4.56`.

## Parameters

Parameter | Description | Required
--- | --- | ---
AgentName | The name of the agent to read. | see Comments
AID | The agent ID of the agent to read. | see Comments
DeferLogin | Use another system for user authentication. |
EmailAddress | The e-mail address of the user. |
FieldFieldName | A field for the new agent. |
InputEncoding | The encoding of the AgentName and UserName values. |
OutputEncoding | Converts the encoding of the text that the action returns. |
Security | A field for the user to store user security details. |
ShowTerms | Shows the agent terms. |
UID | The ID of the user that the agent belongs to. | see Comments
UserDetails | Whether to return user details with the results. |
UserName | The user name of the user that the agent belongs to. | see Comments

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
EncryptResponse | Encrypt the output.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

## Comments

You must set one of the following parameter combinations:

- AID

- UserName and AgentName

- UID and AgentName

© 2016 Hewlett Packard Enterprise Development LP | Send documentation feedback to HPE Close Send Documentation Feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to AutonomyTPFeedback@hpe.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_HP_HTML5_bannerTitle.htm