Community Component 25.3
Community Component Help

# AgentGetResults

Queries the Content component data index with an agent and returns the agent results.

You must specify the agent to get results for by setting one of the following parameter combinations:

- AID
- AgentName and UserName
- AgentName and UID

## Example

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

This action requests the results 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 query.
AID | The agent ID of the agent to query.
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
--- | ---
AddSetToReadDocuments | Whether to add agent results to the list of recently viewed documents.
AgentBoolean | Include Boolean restrictions in the query.
AgentField | An agent field whose value determines if the agent is included.
AgentFieldText | Include `FieldText` restrictions in the query.
DREQueryParameter | Add `Query` action parameters.
EmailAddress | The e-mail address of the user.
ExcludeReadDocuments | Whether to exclude read documents from results returned to the user.
FieldFieldName | A field for the new agent.
InputEncoding | The encoding of the AgentName, UserName, and ViewingUserName values.
OutputEncoding | Converts the encoding of the text that the action returns.
Security | A field for the user to store user security details.
UserDetails | Whether to return user details with the results.
UserFieldMatch | Restricts which user fields are displayed.
ViewingUserName | The user name of a user that can view the agent results although they are not the owner of the agent.

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 2025 Open Text
Version 25.3 | Last updated July 2025

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 25.3

Topic Title: AgentGetResults