ReqIF REST API endpoints
The {id} in the endpoints below represents the ReqIF conversation integration ID.
Capability | Method and endpoint | Primary purpose |
|---|---|---|
Upload import file | PUT /labs/v1/reqif/{id}/upload-file | Stores the source ReqIF or ReqIFz file for a conversation before the import begins. If a file was uploaded with the same mapping, you can replace it. |
Start import | POST /labs/v1/reqif/{id}/import | Starts asynchronous import processing for the uploaded file. |
Check import status | GET /labs/v1/reqif/{id}/IMPORT/status | Returns the latest persisted IMPORT process status. |
Start export | POST /labs/v1/reqif/{id}/export | Starts asynchronous export processing. |
Check export status | GET /labs/v1/reqif/{id}/EXPORT/status | Returns the latest persisted EXPORT process status. |
Download export file | GET /labs/v1/reqif/{id}/download-file | Retrieves the generated export file after the export completes. |