JobGetResponse
Interface for job response
Extends¶
Properties¶
| Property | Type | Description |
|---|---|---|
batchExecutionKey |
string |
The unique identifier grouping multiple jobs, usually generated when started by a schedule |
createdTime |
string |
The date and time when the job was created |
endTime |
null | string |
The date and time when the job execution ended, or null if the job hasn't ended yet |
entryPointPath |
null | string |
Path to the entry point workflow (XAML) that will be executed by the robot |
environmentVariables |
null | string |
Environment variables as a JSON string passed to the job execution |
errorCode |
null | string |
The error code associated with a failed job |
folderId |
number |
- |
folderKey |
null | string |
The folder key (GUID) of the folder this job is part of |
folderName |
null | string |
- |
hostMachineName |
null | string |
The name of the machine where the robot ran the job |
id |
number |
The unique numeric identifier of the job |
info |
null | string |
Additional information about the current job |
inputArguments |
null | string |
Input parameters as a JSON string passed to job execution |
jobError |
null | JobError |
Error details for the job, or null if the job has no errors |
jobPriority |
null | JobPriority |
The execution priority of the job |
key |
string |
The unique job identifier (GUID) |
lastModifiedTime |
null | string |
The date and time when the job was last modified |
machine? |
Machine |
The machine associated with the job (available when using expand=Machine) |
maxExpectedRunningTimeSeconds |
null | number |
Expected maximum running time in seconds before the job is flagged |
outputArguments |
null | string |
Output parameters as a JSON string resulted from job execution |
packageType |
PackageType |
The package type of the process associated with the job |
parentJobKey |
null | string |
The parent job key (GUID), set when the job was started by another job |
parentSpanId |
null | string |
The parent span ID for distributed tracing |
process? |
null | ProcessMetadata |
The process metadata associated with the job (available when using expand=Release) |
processName |
null | string |
The name of the process (release) associated with the job |
processVersionId |
null | number |
The process version ID |
reference |
null | string |
Reference identifier for the job, used for external correlation |
remoteControlAccess |
RemoteControlAccess |
The remote control access level for the job |
requiresUserInteraction |
boolean |
Whether the job requires user interaction |
resumeOnSameContext |
boolean |
If set, the job will resume on the same robot-machine pair on which it initially ran |
resumeTime |
null | string |
The date and time when the job was resumed after suspension |
resumeVersion |
null | number |
Distinguishes between multiple job suspend/resume cycles |
robot? |
RobotMetadata |
The robot associated with the job (available when using expand=Robot) |
runtimeType |
null | RuntimeType |
The runtime type of the robot which can pick up the job |
serverlessJobType |
null | ServerlessJobType |
The type of the serverless job, or null for non-serverless jobs |
source |
null | string |
The source name of the job, describing how the job was triggered |
sourceType |
JobSourceType |
The source type indicating how the job was triggered |
specificPriorityValue |
null | number |
Value for more granular control over execution priority (1-100) |
startingScheduleId |
null | number |
The ID of the schedule that started the job, or null if started by the user |
startingTriggerId |
null | string |
The starting trigger ID, can be ApiTriggerId or HttpTriggerId |
startTime |
null | string |
The date and time when the job execution started, or null if the job hasn't started yet |
state |
JobState |
The current execution state of the job |
stopStrategy |
null | StopStrategy |
The stop strategy for the job |
subState |
null | JobSubState |
The sub-state in which the job is, providing more granular status information |
targetRuntime |
null | string |
The target runtime for the job |
traceId |
null | string |
The trace ID for distributed tracing |
type |
JobType |
The type of the job - Attended if started via the robot, Unattended otherwise |