Sign in

v6

latestSwagger 2.02026-07-1342142196.4 KB
Tasks

Cancel a task by taskId.

post/tasks/{taskId}:cancel

Path parameters

taskIdstring required

The unique identifier of the task.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

idstring required

The unique identifier of the task.

startedAtstring date-time

The time the task started.

completedAtstring date-time

The time the task completed.

lastPolledAtstring date-time

The last time the status of the task was updated.

state'pending' | 'running' | 'paused' | 'complete' | 'incomplete' | 'failed' | 'warning'

The state the task is in.

phase'running' | 'polling' | 'complete'

The phase the task is in.

reasonstring

The reason the task was moved into its current state, if the task wasn't completed.

metadataobject

Attributes unique to the task. This differs by task type.