Skip to main content

Jama Connect Interchange Help

Import and export ReqIF files

Upload a ReqIF or ReqIFz file, start and monitor the import, generate an export, and download the completed export file.

Parameters

  • Replace {id} with the conversation integration ID.

  • Replace <jci-username>:<jci-password> with the Jama Connect Interchange username and password.

  • Replace jci.example.com with your Jama Connect Interchange host.

To import and export ReqIF files:

  1. Upload the import file — Use the upload endpoint to associate a ReqIF or ReqIFz file with the target conversation before calling the import start endpoint.

    Endpoint

    PUT /labs/v1/reqif/{id}/upload-file

    Sample Request

    curl -X PUT "https://jci.example.com/labs/v1/reqif/12345/upload-file" \
   -H "Content-Type: application/json" \
   -u "<jci-username>:<jci-password>" \
   -F "file=@/files/requirements.reqif"

  2. Start the import — After uploading the file, call the import endpoint to begin asynchronous processing.

    Endpoint

    POST /labs/v1/reqif/{id}/import

    Sample Request

    curl -X POST "https://jci.example.com/labs/v1/reqif/12345/import" \
   -H "Content-Type: application/json" \
   -u "<jci-username>:<jci-password>" \
   -d "{}"

    Successful Response

    202 Accepted
{  
   "integrationId": "12345",
   "statusUrl": "/labs/v1/reqif/12345/IMPORT/status"
}

  3. Check the integration status

    Endpoints

    • GET /labs/v1/reqif/{id}/IMPORT/status

    • GET /labs/v1/reqif/{id}/EXPORT/status

    Use the status REST API endpoints to:

    • Poll after an accepted import request

    • Poll after an accepted export request

    • Protect upload and import-start operations from concurrent IMPORT activity

    • Confirm when export output is ready to download

    • Understand when the process is Running, Completed, or Failed

    Sample Request — Import

    curl -X GET "https://jci.example.com/labs/v1/reqif/12345/IMPORT/status" \
   -H "Accept: application/json" \
   -u "<jci-username>:<jci-password>"

    Sample Request — Export

    curl -X GET "https://jci.example.com/labs/v1/reqif/12345/EXPORT/status" \
   -H "Accept: application/json" \
   -u "<jci-username>:<jci-password>"

  4. Start the export — Use the export endpoint to generate a ReqIF output file from the target conversation context.

    Endpoint

    POST /labs/v1/reqif/{id}/export

    Sample Request

    curl -X POST "https://jci.example.com/labs/v1/reqif/12345/export" \
   -H "Content-Type: application/json" \
   -u "<jci-username>:<jci-password>" \
   -d "{}"

    Successful Response

    202 Accepted 
{ 
  "integrationId": "12345", 
   "statusUrl": "/labs/v1/reqif/12345/EXPORT/status" 
}

  5. Download the export file — After the export completes successfully, use the download endpoint to retrieve the generated ReqIF output file.

    You can download the file only when the latest persisted EXPORT status is COMPLETED and an export artifact exists. A RUNNING or FAILED export, or a missing artifact, returns separate error responses.

    Endpoint

    GET /labs/v1/reqif/{id}/download-file

    Sample Request

    curl -X GET "https://jci.example.com/labs/v1/reqif/12345/download-file" \
   -H "Accept: application/octet-stream" \
   -u "<jci-username>:<jci-password>" \
   --output exported-requirements.reqif
In this section: