Skip to main content
POST
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required
jobId
string
required

Body

application/json
branch_name
string
required

Name for the branch the import lands on.

clauses
object[]
required

The mapping clauses the wizard configured, in precedence order (the first clause matching an object wins). Each clause names the target Flow category, the ReqIF value that becomes the Source ID, the Flow field the object is matched against, the per-attribute field mappings, the enum-option mappings, and an optional disambiguation filter. ReqIF types with no clause are skipped.

base_branch_id
string

Base branch to fork the import branch from. Omit or "master" for the base branch.

Per-ReqIF-link-type direction choice. Absent link types default to downstream.

parent_id
string

Optional Flow parent entity to nest imported roots under.

Response

200 - application/json
created_at
string<date-time>
required
id
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).