AgentChangeDocsReadStatus
Allows you to specify a set of documents to mark as read or unread for an agent.
You must specify the agent to modify by setting one of the following parameter combinations:
You use the DocRefs parameter to specify the documents to change the read status of, and you set MarkAsRead to True
or False
to specify whether to mark the document as read or unread.
Example
http://12.3.4.56:9000/action=AgentChangeDocsReadStatus&UserName=Administrator&AgentName=Global+Warming&DocRefs=1234,5678,2953&MarkAsRead=True
This action modifies the agent called Global Warming
for the Administrator
user, and marks the documents with the IDs 1234
, 5678
, and 2953
as read, so that they do not return in the agent results.
Required Parameters
You must set at least one of the following parameters.
Parameter | Description |
---|---|
AgentName | The name of the agent to modify. |
AID | The ID of the agent to modify. |
UID | The ID of the user that owns the agent. |
UserName | The name of the user that owns the agent. |
Optional Parameters
This action accepts the following optional parameters.
Parameter | Description |
---|---|
DocRefs | A comma-separated list of document references to mark as read or unread. |
MarkAsRead | Whether to mark the document as read. |
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. |