Sign in
Purge

Get the result of a purge request

Get the result of a purge request.

get/sources/{sourceKey}/v1/purge/{purgeId}

Path parameters

sourceKeystring required

The key of the source.

purgeIdstring required

ID of the purge job.

Response

Gets the current status of the purge job.

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>).
purgeIdstring required

ID of the purge operation. Deprecated, please use the taskId instead.

collectionType'resources' | 'relationships' | 'objects' required
collectionKeystring required

Key of the resource or relationship collection.

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

Status of the operation.

  • SUCCESS: The operation was persisted in the source, or was dropped by a reject action of the user.
  • PENDING: The operation is being processed asyncronously by the system or is in a pipeline IN_REVIEW status.
  • CANCELLED: The operation was cancelled by the system due to a concurrent operation.
  • FAILURE: The operation failed due to validation or processing error.
deletedCountinteger

Number of documents deleted in case of success status.

createdAtstring date-time
updatedAtstring date-time

Changes

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