> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flowengineering.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Commit a ReqIF import with the chosen mapping

> Queues the durable write of the parsed document onto its reserved branch. Poll the job for progress and the branch id.



## OpenAPI

````yaml /openapi/customer-api.json post /project/{projectId}/reqif-import/{jobId}/commit
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /project/{projectId}/reqif-import/{jobId}/commit:
    post:
      tags:
        - ReqIF Import
      summary: Commit a ReqIF import with the chosen mapping
      description: >-
        Queues the durable write of the parsed document onto its reserved
        branch. Poll the job for progress and the branch id.
      operationId: ReqifImportController_commit
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            type: string
        - in: path
          name: jobId
          required: true
          schema:
            type: string
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommitReqifImportDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReqifImportJobResponseDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    CommitReqifImportDto:
      properties:
        base_branch_id:
          description: >-
            Base branch to fork the import branch from. Omit or "master" for the
            base branch.
          type: string
        branch_name:
          description: Name for the branch the import lands on.
          type: string
        clauses:
          description: >-
            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.
          items:
            type: object
          type: array
        link_direction_by_type:
          description: >-
            Per-ReqIF-link-type direction choice. Absent link types default to
            downstream.
          type: object
        parent_id:
          description: Optional Flow parent entity to nest imported roots under.
          type: string
      required:
        - clauses
        - branch_name
      type: object
    ReqifImportJobResponseDto:
      properties:
        branch_id:
          nullable: true
          type: string
        branch_name:
          nullable: true
          type: string
        id:
          type: string
        items_done:
          type: number
        items_total:
          nullable: true
          type: number
        last_error:
          nullable: true
          type: string
        last_error_reference:
          nullable: true
          type: string
        phase:
          type: string
        schema:
          description: File-derived schema for the mapping wizard (once parsed).
          nullable: true
          type: object
        status:
          enum:
            - awaiting_upload
            - parsing
            - parsed
            - importing
            - succeeded
            - failed
            - cancelled
          type: string
      required:
        - id
        - status
        - phase
        - items_done
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````