| 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/cancel
This method aborts all robotic tasks with IDs that match the given list of robotic task IDs and statuses.
| Parameter | Type | Example | Required? | Description |
|---|---|---|---|---|
robotIds |
List of String | ["60cb47c3546ede51ffe04dbb", "5dcd86ed17d0b602a53ce2d1"] |
Yes | List of unique robotic task identifiers and the execution number displayed in Appian. The value before # symbol is the identifier of the robotic task, and the value after the # symbol is the execution number seen in Appian. |
status |
String | "ENQUEUED" | Yes | A robotic task can have the status "ENQUEUED", "RUNNING", or "SCHEDULED". |
Example request body:
1
2
3
4
{
"robotIds" : ["60cb47c3546ede51ffe04dbb#13","5dcd86ed17d0b602a53ce2d1#41"],
"status" : "ENQUEUED"
}
The call is successful if "invocationResult" = "OK".
| Element | Example | Data type | Description |
|---|---|---|---|
executions |
See below | List of Execution | The list of execution objects that correspond with canceled executions. |
id |
13 | Integer | Unique identifier of the execution |
executionNumber |
13 | 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. |
robotCustomName |
"testRobot" | String | Human-readable name given to the robotic task. |
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. |
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. |
duration |
3334 | String | The length of time it took to execute the task. 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. |
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 |
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": 1671033366520,
"errorMessage": null,
"nextPageToken": null
"executions": [
{
"id": "13",
"executionNumber": 13,
"robotName": "63974fdc497630026cf29757",
"robotCustomName": "RobotName",
"robotId": "60cb47c3546ede51ffe04dbb",
"nodeName": null,
"nodeCustomName": null,
"nodeId": null,
"startTimeMillis": 0,
"endTimeMillis": 0,
"duration": 0,
"result": "ENQUEUED",
"itemsTotal": 0,
"itemsOk": 0,
"itemsWarn": 0,
"testExecution": false,
"username": "administrator",
"description": "",
"averageTime": "00h 00m 00s",
"workItemsAverageTime": "00h 00m 00s",
"failedSectionName": null
}
]
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):
Cancel Executions
