Last updated: May 04, 2020 09:28
Gets the status of the running or recently completed execution specified by the <executionId>.
The <executionId> is the execution identifier returned by the Start New Script Execution operation.
Note: All REST API commands require authentication, see the general authentication methods here.
|securityToken*||A unique cryptographic key assigned to an authorized user.|
true to allow users with administrative credentials to get the status of an execution started by other automation users.
The format to use for the response. Possible values: xml, json.
* Mandatory parameter
The reason for the end code returned by flowEndCode. This can be used for diagnosing the cause of an execution failure.
The information of the devices used in the script. Includes the id, manufacturer and model.
The description of the current execution status.
true if the execution had completed.
The completion code of the execution. The following is a list of the possible return values:
The description of the execution completion status.
The count of failed validations.
The progress percentage of the running execution.
The identifier that you can use to download the execution report from the repository. The key is only valid once the script's execution completes and does not expire. For example, PRIVATE:reportName.xml.
The count of failed actions.
The current status of the execution. The following is a list of the possible return values:
Initializing - The execution is initializing and preparing to run the specified script
Waiting for resources - The execution is awaiting resources required by the script
Running - The execution is performing the functions coded in the script
Terminating - The execution completed the last function in the script and is performing cleanup operations, e.g. finalizing the video, updating data structures, releasing resources.
Completed - The execution has completed and is no longer running
If the execution was invoked by another execution, this field contains the execution identifier of the parent execution. This field can be used to identify child executions, or to query the status of a parent execution.
This example shows the request and response for getting the status of the execution with the specified <executionId> without specifying any optional parameters.