CLclinia
Purge

Purge operation request for resources or relationships

Purge operation request for resources or relationships.

post/sources/{sourceKey}/v1/purge

Request

  • Base URL
    https://.clinia.cloud
  • URL
    https://.clinia.cloud/sources/{sourceKey}/v1/purge
  • Auth
    API key in header X-Clinia-API-Key

Path parameters

sourceKeystring required

The key of the source.

Request body

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

Key of the resource or relationship collection.

Response

A successful response for a valid and accepted purge operation with status 'ACCEPTED'.

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>).
status'ACCEPTED' | 'PERSISTED' required

Status of the task submission.

  • ACCEPTED: The task has been accepted for asynchronous processing. The task will be executed in the background.
  • PERSISTED: The task has been executed synchronously and the results are immediately persisted.

Changes

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