tasks

Get Details about a specific task by its ID.

get/management/v1/warehouse/{warehouse_id}/task/by-id/{task_id}

Request

Path parameters

warehouse_idstring uuid required
task_idstring uuid required

Query parameters

numAttemptsinteger nullable

Number of attempts to retrieve (default: 5)

Response

attemptinteger required

Current attempt number

created-atstring date-time required

When this task attempt was created

entity-namestring[] nullable

Name of the entity this task operates on. None if this is a warehouse-level task.

last-heartbeat-atstring date-time nullable

Last heartbeat timestamp for running tasks

parent-task-idstring uuid nullable

Parent task ID if this is a sub-task

picked-up-atstring date-time nullable

When the latest attempt of the task was picked up for processing by a worker.

progressnumber float required

Progress of the task (0.0 to 1.0)

project-idstring required

Project ID associated with the task

queue-namestring required

Name of the queue processing this task

scheduled-forstring date-time required

When the latest attempt of the task is scheduled for

status'RUNNING' | 'SCHEDULED' | 'STOPPING' | 'CANCELLED' | 'SUCCESS' | 'FAILED' required
task-idstring uuid required

Unique identifier for the task

updated-atstring date-time nullable

When the task was last updated

warehouse-idstring uuid required

Warehouse ID associated with the task

execution-detailsobject nullable

Execution details for the current attempt

messagestring nullable

Message for the current attempt: success result details if it succeeded, or the failure reason if it failed. null while the attempt is still running or scheduled.

task-dataobject required

Task-specific data

Example response

{
  "attempts": [
    {
      "duration": "PT1H30M45.5S"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.