Get Robotic Process Results

Remember to include the appropriate authentication headers in your HTTP request message when using this method.

Get Robotic Process Results

POST: /robot/result

This method returns the results of a robotic process execution.

Request body

Parameter Example Required? Description
executionId "5eda733e760e2c31fbaaee70#1" Yes 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 request body:

1
2
3
{
    "executionId" : "5eda733e760e2c31fbaaee70#1"
}

Response

The call is successful if "invocationResult" = "OK".

The following elements are provided in the result key.

Element Example Data type Description
lastUpdated 1591385144263 String Date and time the execution was last updated, expressed in UNIX epoch time
Units: milliseconds
errorMessage "The execution does not exist, has been deleted, or you do not have permission to view it." String Error message when the "invocationResult" is "KO"
result SUCCESS String Execution result. Possible values are: SUCCESS, FAILURE, ABORTED, RUNNING, ENQUEUED

Example response body:

1
2
3
4
5
6
7
8
9
{
    "invocationResult": "OK",
    "result": {
        "lastUpdated": 1627589311229,
        "errorMessage": null,
        "result": "SUCCESS"
    },
    "exceptionThrownText": null
}

Troubleshooting

Possible reasons calls may be unsuccessful ("invocationResult" = "KO"):

  • User has no permission to view or access the robotic process
  • The executionId is invalid or missing
  • The executionId is not in the correct format
  • An invalid API key was used to make the request

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

On This Page

FEEDBACK