v4

latestOpenAPI 3.0.22026-07-3188146256.6 KB
Import-Export

Abort a running entity import

Asks a running import to stop. Rows already imported are kept - this is a stop, not a rollback - and the job still produces its result reports for everything that landed before the stop, then reaches the terminal status CANCELLED.

The stop is cooperative: the worker notices the request at its next batch boundary, so the job typically reaches CANCELLED within seconds. Poll POST /v1/entity:import with the job_id as usual to observe it.

Idempotent - aborting an already-aborted or already-finished job is not an error.

post/v1/entity:abortImport

Query parameters

job_idstring required

The unique identifier of the import job.

Example:abc123

The ID of the import job to stop.

schemastring required

Slug of the schema being imported, used to authorize the caller.

Response

The stop was requested. The job is still running until the worker picks the request up.

statusstring

The job status at the time of the request.

jobPollIdstring