Sign in

v1

latestOpenAPI 3.0.12026-07-1431191129.7 KB
Task

Get a task from the registry

Get the operation receipts related to a task id.

get/sources/{sourceKey}/v1/tasks/{taskId}

Path parameters

sourceKeystring required

The source key.

taskIdstring required

The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

  • oneOf task: s_<id>.
  • bulk task: bk_<id> (deprecated: <id> only).
  • bundle task: bd_<id> (deprecated: <id> only).
  • purge task: pg_<id> (deprecated: purge:<id>).

The task id.

Query parameters

withReceiptsboolean

If set to true, the operation receipts of the task will be included in the response. Else only the status of the task will be returned.

Response

The task with the given id.

status'SUCCESS' | 'PENDING' | 'CANCELLED' | 'FAILURE' required

Status of the task.

  • SUCCESS: All the operations of the task completed successfully.
  • PENDING: At least one operation in the task is still pending.
  • CANCELLED: All the operations in the task were cancelled.
  • FAILURE: At least one operations failed or was cancelled.
taskIdstring required

The task identifier. Used to track an async task in the system. Use the task ID to poll for completion status. The taskId holds different prefix to represent different tasks.

  • oneOf task: s_<id>.
  • bulk task: bk_<id> (deprecated: <id> only).
  • bundle task: bd_<id> (deprecated: <id> only).
  • purge task: pg_<id> (deprecated: purge:<id>).