| 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/items
This method returns the list of items from one or more executions, when specified by executionId. If no executionId is specified, it returns all items processed within the date range.
The items to return must have been processed within the specified date range.
| Parameter | Example | Required? | Description |
|---|---|---|---|
dateRange.start |
1461457843868 | Yes | Date and time expressed in UNIX epoch time Units: milliseconds |
dateRange.end |
1561457843866 | Yes | Date and time expressed in UNIX epoch time Units: milliseconds |
executionId |
"27" | No | Execution ID to filter the list of results. The field id in the response from the /execution/list/completed endpoint contains this information. |
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
{
"dateRange" : {
"start" : 1622505600000,
"end" : 1625097599000
},
"executionId" : "27",
"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.items key.
| Element | Example | Data type | Description |
|---|---|---|---|
id |
null | Integer | Internal id for the executed robotic task |
robotName |
"5e4a72abe18edacba723b298" | String | Robotic task name, immutable since creation |
robotCustomName |
"robot-developmentguide-queues-search" | String | Robotic task human-readable name |
robotId |
"5e4a72abe18edacba723b299" | String | Unique id for the executed robotic task |
executionNumber |
1 | Integer | Execution number |
executionId |
"27" | Integer | Execution id |
itemIndex |
2 | Integer | Item index in this execution |
itemKey |
"item1" | String | Item key |
itemResult |
"OK" | String | Result |
itemSubResult |
null | String | Sub-result |
itemSubResultText |
null | String | Sub-result in text format |
itemResultDetail |
"" | String | Result details in text format |
properties |
"Time required": "0.33", "Number of results":"315000" | Map | Map of properties associated with the execution |
currentTimeMillis |
1586870440301 | String | Time the queue items was processed, expressed in UNIX epoch time Units: milliseconds |
duration |
3334 | String | The length of time it took to process the item Units: milliseconds |
testing |
false | String | Boolean indicating whether this execution was a test |
Example response body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
"invocationResult":"OK",
"result":{
"lastUpdated":1627668581125,
"errorMessage":null,
"nextPageToken":null,
"items":[
{
"id":null,
"robotName":"5e4a72abe18edacba723b298",
"robotCustomName":"robot-developmentguide-queues-search",
"robotId":"5e4a72abe18edacba723b298",
"executionNumber":1,
"executionId":"27",
"itemIndex":2,
"itemKey":"item2",
"itemResult":"OK",
"itemSubResult":null,
"itemSubResultText":null,
"itemResultDetail":null,
"properties":[
{
"Time required":"0.33",
"Number of results":"315000"
}
],
"currentTimeMillis":1586870440301,
"duration":3334,
"testing":false
}
]
},
"exceptionThrownText":null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
Get Robotic Task Items
