Commit a ReqIF import with the chosen mapping - Flow

POST

/

project

/

{projectId}

/

reqif-import

/

{jobId}

/

commit

Commit a ReqIF import with the chosen mapping

curl --request POST \
  --url https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "branch_name": "<string>",
  "clauses": [
    {}
  ],
  "base_branch_id": "<string>",
  "link_direction_by_type": {},
  "parent_id": "<string>"
}
'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit"

payload = {
    "branch_name": "<string>",
    "clauses": [{}],
    "base_branch_id": "<string>",
    "link_direction_by_type": {},
    "parent_id": "<string>"
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    branch_name: '<string>',
    clauses: [{}],
    base_branch_id: '<string>',
    link_direction_by_type: {},
    parent_id: '<string>'
  })
};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "items_done": 123,
  "phase": "<string>",
  "status": "awaiting_upload",
  "branch_id": "<string>",
  "branch_name": "<string>",
  "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

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.

link_direction_by_type

object

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

id

string

required

items_done

number

required

phase

string

required

status

enum<string>

required

Available options:

awaiting_upload,

parsing,

parsed,

importing,

succeeded,

failed,

cancelled

branch_id

string | null

branch_name

string | null

items_total

number | null

last_error

string | null

last_error_reference

string | null

schema

object | null

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

Commit a ReqIF import with the chosen mapping

curl --request POST \
  --url https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'customer: <customer>' \
  --data '
{
  "branch_name": "<string>",
  "clauses": [
    {}
  ],
  "base_branch_id": "<string>",
  "link_direction_by_type": {},
  "parent_id": "<string>"
}
'

import requests

url = "https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit"

payload = {
    "branch_name": "<string>",
    "clauses": [{}],
    "base_branch_id": "<string>",
    "link_direction_by_type": {},
    "parent_id": "<string>"
}
headers = {
    "customer": "<customer>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    customer: '<customer>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    branch_name: '<string>',
    clauses: [{}],
    base_branch_id: '<string>',
    link_direction_by_type: {},
    parent_id: '<string>'
  })
};

fetch('https://backend.branch.flowengineering.com/project/{projectId}/reqif-import/{jobId}/commit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "items_done": 123,
  "phase": "<string>",
  "status": "awaiting_upload",
  "branch_id": "<string>",
  "branch_name": "<string>",
  "items_total": 123,
  "last_error": "<string>",
  "last_error_reference": "<string>",
  "schema": {}
}