Execute Robot with Parameters

POST: /robot/runWithParams

This method launches a robot with or without parameters (formerly called instructions).

The only required input field is robotName.

Input parameters

robotName must be specified in order to retrieve its history.

Parameter Example Comments
robotName 5e7dd431e4b08f477f06ba65 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 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 Description for the execution.
stepMode false Indicates whether the step-by-step mode applies or not.
instructions - Array of data; each of the parameters the robotic process needs to be executed.
instructions.name batch The name of the parameter in the robotic process's configuration.
instructions.fileNameValue my-file.txt 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 The value for the parameter for the execution

Output ("invocationResult" is "OK")

Attribute Example Comments
id 42 Execution identifier
robotExecutionId 5e7dd431e4b08f477f06ba65#14 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.

Possible reasons for unsuccessful events ("invocationResult" is "KO")

None


This version of the Appian RPA documentation was written for Appian 21.2, and does not represent the interfaces or functionality of other Appian versions.
Open in Github Built: Fri, Oct 22, 2021 (11:11:24 AM)

On This Page

FEEDBACK