| 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: /execution/list/completed
This method returns the list of executions completed inside 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 |
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
{
"dateRange" : {
"start" : 1622505600000,
"end" : 1625097599000
},
"pageSize" : 2
}
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.executions key.
| Element | Example | Data type | Description |
|---|---|---|---|
id |
12 | Integer | Unique identifier of the execution |
executionNumber |
1 | Integer | The number of the execution displayed in the RPA console. This value is not necessarily unique and can be re-used in the user interface as old executions are deleted and new executions run. |
robotName |
"robot-tutorial-QuickStart" | String | Robotic task custom name executed. |
robotId |
"5da9aafe4cea9d1772d9031c" | String | Robotic task unique ID executed. |
nodeName |
"test1#1" | String | ID of the robot that executed the robotic task. |
nodeId |
"5da9aafe4cea9d1772d9ef72" | String | Unique ID of the robot that executed the robotic task. |
username |
"testUsername" | String | User who executed the robotic task. |
description |
"a test robot" | String | Description of the robotic task. |
averageTime |
"00h 00m 12s" | String | Average time taken to process all work items. Calculated as totalExecutionTime/itemsTotal |
workItemAverageTime |
"00h 00m 13s" | String | Average time taken to process one work item. Calculated as totalWorkItemsTime/itemsTotal |
starttimeMillis |
1542281894653 | Integer | Date and time when execution started, expressed in UNIX epoch time. Units: milliseconds. |
endTimeMillis |
1542281901183 | Integer | Date and time when execution ended, expressed in UNIX epoch time. Units: milliseconds. |
result |
"SUCCESS" | String | Result of execution. |
itemsTotal |
1 | Integer | Total items processed. |
itemsOk |
1 | Integer | Total items processed with SUCCESS result. |
itemsWarn |
0 | Integer | Total items processed with WARN result. |
testExecution |
"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
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1623871619546,
"errorMessage": null,
"nextPageToken": null,
"executions": [
{
"id": "1",
"executionNumber": 1,
"robotName": "5f777726b74c002dc659988e",
"robotCustomName": "rest_test",
"robotId": "5f777726b74c002dc659988f",
"nodeName": "60c97b07bb4e0a77c3d38c7c#1",
"nodeCustomName": "test-robot-927",
"nodeId": "60c97b08bb4e0a77c3d38c7d",
"startTimeMillis": 1623817521661,
"endTimeMillis": 1623817527280,
"result": "SUCCESS",
"itemsTotal": 0,
"itemsOk": 0,
"itemsWarn": 0,
"testExecution": false,
"username": "serviceaccount",
"description": "Execution @ test-robot (60c97b07bb4e0a77c3d38c7c#1) by serviceaccount (api)",
"averageTime": "00h 00m 00s",
"workItemsAverageTime": "00h 00m 00s"
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
