POpolytomic
Bulk Sync

Cancel Bulk Sync Schema

Changed on

Requests cancellation of any running executions for a specific schema on a bulk sync. A schema whose only running work is a backfill returns a conflict.

Cancellation is asynchronous. A successful response means the cancellation signal for this schema has been queued; the schema's in-flight work continues until the signal is processed. Poll GET /api/bulk/syncs/{id}/schemas/{schema_id} and the parent execution via GET /api/bulk/syncs/{id}/status to confirm the schema has reached a terminal state.

post/api/bulk/syncs/{id}/schemas/{schema_id}/cancel

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring uuid required

The bulk sync ID

Example:248df4b7-aa70-47b8-a036-33ac447e668d
schema_idstring required

The schema ID to cancel for the bulk sync

Headers

X-Polytomic-Versionstring

Response

OK

Example response

{
  "data": {
    "message": "Cancellation requested"
  }
}

Changes

  • 61c2b96f65baRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • a4c3b8f8eff7Revision changes
    • info

      added the non-success response with the status