Community Component 26.3
Community Component Help

# AgentRead

Allows you to view agent details.

You must specify the agent by setting one of the following parameter combinations:

- AID
- AgentName and UserName
- AgentName and UID

## Example

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

This action requests the details of the `Global Warming` agent for the `Administrator` user.

## Required Parameters

You must set at least one of the following parameters.

Parameter | Description
--- | ---
AgentName | The name of the agent to read.
AID | The agent ID of the agent to read.
UID | The ID of the user that the agent belongs to.
UserName | The user name of the user that the agent belongs to.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
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.
UserDetails | Whether to return user details with the results.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
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

Copyright 2026 Open Text
Version 26.3 | Last updated July 2026

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Community Component 26.3

Topic Title: AgentRead