Keywords:
Signals Research Suite, API export, project file export, entity parameter, API troubleshooting, export-service, curl command
Products:
Signals Research Suite
Description:
Users may encounter issues when attempting to export project files using the Signals Research Suite API. Specifically, an error can occur if the entity parameter in the API call includes an incorrect file extension, such as .csv. This article provides guidance on correcting the API call to ensure successful file export.
API Information:
To export a project file using the API, use the following endpoint:
/project-service/projects/{projectUID}/revisions/{revisionNumber}/export
You can view the API documentation and test the API call using the following URL: API Documentation
https://<ServerName>.signalsresearch.revvitycloud.com/datafactory/apidocs#/export-service/getProjectserviceProjectsProjectuidRevisionsRevisionnumberExport
Issue: The following API call may fail due to an incorrect entity parameter:
curl -X 'GET' \
'https://<Servername>.signalsresearch.revvitycloud.com/datafactory/project-service/projects/5/revisions/0/export?entity=Batch_Assay_Endpoint_Results.csv&compressed=false&format=csv' \
-H 'accept: application/json'
The issue is caused by the .csv extension in the entity parameter.
Resolution: To fix the issue, remove the .csv extension from the entity parameter. Use the corrected API call:
curl -X 'GET' \
'https://<Servername>.signalsresearch.revvitycloud.com/datafactory/project-service/projects/5/revisions/0/export?entity=Batch_Assay_Endpoint_Results&compressed=false&format=csv' \
-H 'accept: application/json'
This correction ensures that the API correctly identifies the entity and processes the export request.
Next Steps:
- If the issue persists, consult the API Documentation or contact Revvity support for further assistance.