Cancel Bulk Sync Schema | Polytomic Docs

Requests cancellation of any running executions for a specific schema on a bulk sync.

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.

Requests cancellation of any running executions for a specific schema on a bulk sync. 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.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

AuthorizationBearer

This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"

The bulk sync ID.

schema_idstringRequired

The schema ID to cancel for the bulk sync.

Response

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors