| The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply. |
Tip: Remember to include the appropriate authentication headers in your HTTP request message when using this method.
POST: /robot/history
This endpoint returns the list of modifications made to a robotic task in the specified date range. If no date range is specified, it returns all modifications.
If a robotic task has never been modified, this endpoint will return an empty list for historyList. This means that the date of creation is never returned as it's not persisted as a history record.
The dateRange parameter refers to when a robot was modified.
| Parameter | Example | Required? | Description |
|---|---|---|---|
dateRange.start |
1461457843868 | No | Date and time expressed in UNIX epoch time Units: milliseconds |
dateRange.end |
1561457843866 | No | Date and time expressed in UNIX epoch time Units: milliseconds |
robotName |
60cb47c3546ede51ffe04dbb | Yes | The robotic task id, found in the RPA console. |
pageSize |
50 | No | The number of entries to return on each page of results. Acceptable values are between 1 and 250. 250 is the default. |
Example request body:
1
2
3
4
5
6
7
8
{
"robotName" : "60cb47c3546ede51ffe04dbb",
"dateRange": {
"start" : 1622505600000,
"end" : 1625097599000
},
"pageSize": 50
}
The call is successful if "invocationResult" = "OK".
The nextPageToken property is a token used to retrieve the next page of results. To use it, append the nextPageToken key and value to your original request body. The token is valid for 10 minutes and the response keeps generating a new nextPageToken as long as there are more results to retrieve. Each subsequent request should use the nextPageToken sent back in the previous response. When nextPageToken is null in the response, the current page is the last one and there are no more entries to retrieve.
The following elements are provided in the result.historyList key.
| Element | Example | Data type | Description |
|---|---|---|---|
robotName |
"60cb47c3546ede51ffe04dbb" | String | The robotic task id, matching the one contained in the request. |
robotCustomName |
"testRobot" | String | Human-readable name given to the robotic task. |
username |
"admin" | String | Username of person who modified the robotic task. |
lastUpdated |
1569334342000 | String | Date and time the robotic task was modified, expressed in UNIX epoch time Units: milliseconds |
Example response body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1623956346654,
"errorMessage": null,
"nextPageToken": null,
"historyList": [
{
"robotName": "60cb47c3546ede51ffe04dbb",
"robotCustomName": "browser-type-test",
"username": "rpa.admin",
"lastModified": 1623935504000
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
