Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets a task.

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

Path parameters

farmIdstring required

The farm ID of the farm connected to the task.

queueIdstring required

The queue ID for the queue connected to the task.

jobIdstring required

The job ID of the job connected to the task.

stepIdstring required

The step ID for the step connected to the task.

taskIdstring required

The task ID.

Response

Success

taskIdstring required

The task ID.

createdAtstring date-time required

The date and time the resource was created.

createdBystring required

The user or system that created this resource.

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

The run status for the task.

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

The run status with which to start the task.

failureRetryCountinteger

The number of times that the task failed and was retried.

startedAtstring date-time

The date and time the resource started running.

endedAtstring date-time

The date and time the resource ended running.

updatedAtstring date-time

The date and time the resource was updated.

updatedBystring

The user or system that updated this resource.

latestSessionActionIdstring

The latest session action ID for the task.

parametersobject

The parameters for the task.