Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets a step.

get/2023-10-12/farms/{farmId}/queues/{queueId}/jobs/{jobId}/steps/{stepId}

Path parameters

farmIdstring required

The farm ID for the step.

queueIdstring required

The queue ID for the step.

jobIdstring required

The job ID for the step.

stepIdstring required

The step ID.

Response

Success

stepIdstring required

The step ID.

namestring required

The name of the step.

lifecycleStatus'CREATE_COMPLETE' | 'UPDATE_IN_PROGRESS' | 'UPDATE_FAILED' | 'UPDATE_SUCCEEDED' required

The life cycle status of the step.

lifecycleStatusMessagestring

A message that describes the lifecycle status of the step.

taskRunStatus'PENDING' | 'READY' | 'ASSIGNED' | 'STARTING' | 'SCHEDULED' | 'INTERRUPTING' | 'RUNNING' | 'SUSPENDED' | 'CANCELED' | 'FAILED' | 'SUCCEEDED' | 'NOT_COMPATIBLE' required

The task run status for the job.

taskRunStatusCountsobject required

The number of tasks running on the job.

taskFailureRetryCountinteger

The total number of times tasks from the step failed and were retried.

targetTaskRunStatus'READY' | 'FAILED' | 'SUCCEEDED' | 'CANCELED' | 'SUSPENDED' | 'PENDING'

The task status with which the job started.

createdAtstring date-time required

The date and time the resource was created.

createdBystring required

The user or system that created this resource.

updatedAtstring date-time

The date and time the resource was updated.

updatedBystring

The user or system that updated this resource.

startedAtstring date-time

The date and time the resource started running.

endedAtstring date-time

The date and time the resource ended running.

descriptionstring password
<p>The description of the step.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>