v3

OpenAPI 3.1.02026-08-06274467602.9 KB
import

Get Import Job

One import's durable progress — what a reopened dialog reads.

Scoped to the submitting user rather than to the project: the job row is the record of this user's run, and a 404 on someone else's job leaks nothing about whether it exists.

get/api/v1/import/jobs/{job_id}

Path parameters

job_idstring uuid required

Response

Successful Response

idstring uuid required
project_idstring uuid required
status'pending' | 'running' | 'cancelling' | 'completed' | 'failed'

Lifecycle of one background import.

  • PENDING: row inserted, workflow enqueued, no chunk resolved yet
  • RUNNING: the workflow claimed the job and is resolving chunks
  • CANCELLING: the user asked to stop; the workflow observes this at the next chunk boundary and falls through to a normal finalize. Cancel is cooperative, so this is an in-flight state, not a terminal one — the partial commit still has to happen.
  • COMPLETED: finalized, whether every row resolved or only some
  • FAILED: finalized with nothing committed, or the workflow raised
total_rowsinteger
resolved_rowsinteger
committed_rowsinteger
shortfall_rowsinteger
failure_reasonstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable