tasks

Describe a task

Retrieve a task resource.

get/tasks/{id}

Path parameters

idstring required

task id.

The call was successful.

hrefstring

A reference to the task

typestring

The type of task

targetstring

An object on which a referencing task operates

parametersobject

The parameters used as input to a task

createdstring date-time

Time that the task was created.

startedstring date-time

Time that the task was started. This field will be null if the task has not started.

completedstring date-time

Time at which processing for a task completed, or null if not yet completed.

updatedstring date-time

Time at which the task was last updated.

state'pending' | 'running' | 'success' | 'failed'

The current state of the task. success and failed are final states.

descriptionstring

A description of the task

messagestring

This field may contain a message regarding the current state of the task or it may be null.

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