This content applies solely to Appian RPA, which must be purchased separately from the Appian base platform. |
Remember to include the appropriate authentication headers in your HTTP request message when using this method.
POST: /rpa/rest/oo/execution/cancel
This method aborts all robotic processes with IDs that match the given list of robotic process IDs and status.
Parameter | Type | Example | Required? | Description |
---|---|---|---|---|
robotIds |
List of String | ["60cb47c3546ede51ffe04dbb","5dcd86ed17d0b602a53ce2d1"] | Yes | List of unique robotic process IDs |
status |
String | "ENQUEUED" | Yes | A robotic process can have the status "ENQUEUED", "RUNNING", or "SCHEDULED". |
Example request body:
1
2
3
4
{
"robotIds" : ["60cb47c3546ede51ffe04dbb","5dcd86ed17d0b602a53ce2d1"],
"status" : "ENQUEUED"
}
The call is successful if "invocationResult" = "OK".
Element | Type | Description |
---|---|---|
executions |
List of Execution | The list of execution objects that corresponds with canceled executions. |
1
2
3
4
5
6
7
8
9
10
11
12
13
{
"invocationResult": "OK",
"executions": [
{
"robotId": "60cb47c3546ede51ffe04dbb",
"executionNumber": 1,
},
{
"robotId": "5dcd86ed17d0b602a53ce2d1",
"executionNumber": 2,
},
]
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):