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: /robot/runWithParams
This method launches a robot with or without parameters.
Parameter | Example | Required? | Description |
---|---|---|---|
robotName |
"5e7dd431e4b08f477f06ba65" | Yes | Name of the robot to launch. This is not the id (in mongo format) nor the custom name. You can get the name of the robot provided by method /rest/oo/robot/list in the output field name and use it here. |
nodeName |
"5e865b4c4412e6bf6ccf7637#1" | No | Name of the resource on which the execution must be run. This is not the id (in mongo format) nor the custom name. You can get the name of the resource provided by method /rest/oo/node/list in the output field name and use it here. |
description |
"Example description" | No | Description for the execution. |
stepMode |
false | No | Indicates whether the step-by-step mode applies or not. |
instructions |
- | No | Array of data; each of the parameters the robotic process needs to be executed. |
instructions.name |
"batch" | No | The name of the parameter in the robotic process's configuration. |
instructions.fileNameValue |
"my-file.txt" | No | It must be set only if the parameter is a file type. In this case, value must contain the content of the file in BASE64 format. |
instructions.value |
20 | No | The value for the parameter for the execution |
Example request body:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"robotName": "5f84ca6d94cc0d5799b50bc9",
"nodeName": "5e865b4c4412e6bf6ccf7637#1",
"description": "Example description",
"stepMode": false,
"instructions": [
{
"name": "textList",
"value": "{\"#t\": \"string?list\", \"#v\":[\"test1\",\"test2\"]}"
},
{
"name": "singleDecimal",
"value": "{\"#t\": \"decimal\", \"#v\":1.2}"
}
]
}
The call is successful if "invocationResult" = "OK".
Element | Example | Data type | Description |
---|---|---|---|
id |
"5" | Integer | Execution identifier |
robotExecutionId |
"61040365e4b0c8349a1c3366#5" | String | A combination of the robotic process identifier and the execution number displayed in the Appian RPA console. The value before # symbol is the identifier of the robotic process, and the value after the # symbol is the execution number seen in the Appian RPA console. |
Example response body:
1
2
3
4
5
6
7
8
9
10
{
"invocationResult": "OK",
"result": {
"lastUpdated": 1627660857846,
"errorMessage": null,
"id": "5",
"robotExecutionId": "61040365e4b0c8349a1c3366#5"
},
"exceptionThrownText": null
}
Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):