Get Print Job Status Action
Retrieves the status of the specified print job.
A YAML reference document is available that provides complete details about the specific properties for each action and describes how to combine actions into groups and create arrays of actions to be sent as one script to the server. The YAML actions reference is provided as follows:
Action: GetPrintJobStatusAction
Properties
JobId = string.Empty[get, set]
string
Specifies the job ID of the job to be retrieved. The user must provide a valid print job ID in the action script.
ResponseVariable[get, set]
Specifies the name of the variable containing the information on all print queues retrieved by this action. By default, the value is Response.
Name[get, set]
string
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Description[get, set]
string
Specifies the description. The default value is "".
RunType[get, set]
ActionRunType
Runs the action by using one of the following types:
-
Always (default)
-
Never
IgnoreErrors[get, set]
bool
Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.
FailureRetries[get, set]
int
Specifies the number of times the action is retried if it fails. Available only for Action. The default value is 0.
RetryInterval[get, set]
int
Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.
Example
GetPrintJobStatusAction:
JobId: 2024-08-30/47
ResponseVariable: Response
Name: Get Print Job Status
# And more common action properties
...