Get a Script's Running Status |
Gets a script's running status.
|
Note: For more information about this command, including descriptions of any path and request parameters, request body schema, response codes and schemas, and payload examples, refer to the online API reference for this command at the following web page: |
URI
https://bartendercloud.com/api/actions/{id}
|
Note: The bartendercloud.com domain that is referenced in the URI must be replaced with the contents of the DataCenterURI claim that is extracted from your access token. For more information, refer to Extracting the DataCenterURI Claim. |
Path Parameters
id
Type: String
Specifies the ID of the script. Required.
Query Parameters
messageCount
Type: Integer <int32>
Specifies the maximum number of messages that are retrieved after the wait period elapses and the script runs successfully. When the MessageCount parameter is greater than 0, the specified number of the last logged messages is retrieved. The default value is 0. Optional.
messageSeverity
Type: String
Specifies the types of messages that are retrieved after the wait period elapses and the script runs successfully. Valid values are "Error", "Warning", and "Info". When "Error" is specified, only messages that have a severity level of "Error" are retrieved. When "Warning" is specified, messages that have a severity level of "Error" or "Warning" are retrieved. When "Info" is specified, all messages are retrieved. The default value is "Error." Optional.
variables
Type: String
Specifies the variables that should be returned. Multiple variable names can be concatenated by using a comma (,), such as "PrintJobStatus,Response". A wildcard character (*) can be used to specify all variables. If the variable value is binary data, a URL is returned for retrieving that binary data. Note that variables are returned only when the script status is RanToCompletion or Faulted. Optional.