Poll a ReqIF import job

{ "created_at": "2023-11-07T05:31:56Z", "id": "<string>", "items_done": 123, "phase": "<string>", "status": "waiting", "branch_id": "<string>", "branch_name": "<string>", "completed_at": "2023-11-07T05:31:56Z", "items_total": 123, "last_error": "<string>", "last_error_reference": "<string>", "schema": {} }

Authorizations

X-API-Key

string

header

required

Headers

customer

string

required

Workspace identifier

Path Parameters

projectId

string

required

jobId

string

required

Response

200 - application/json

created_at

string<date-time>

required

string

required

items_done

number

required

Completed work in the current phase.

phase

string

required

Where the job is in its plan. A failed job keeps the phase the failure interrupted; status says it failed.

status

enum<string>

required

Who holds the job: the user (waiting), the queue (queued), a worker (running), or nobody again (succeeded, failed).

Available options:

waiting,

queued,

running,

succeeded,

failed,

cancelled

branch_id

string

The branch the import lands on, once reserved.

branch_name

string

completed_at

string<date-time>

items_total

number

Total work in the current phase; absent when it has no measure.

last_error

string

Reader-safe description of the last handled failure. With status "failed" it is the terminal one; with "queued" the job is being retried after it.

last_error_reference

string

Support reference for last_error.

schema

object | null

File-derived schema for the mapping wizard (once parsed).

Quickstart

Automations

Flow MCP

Endpoints

Poll a ReqIF import job

Authorizations

Headers

Path Parameters

Response