GET /rest/export/<export_id>/download
Downloads the file for a completed file export operation.
Request
<service_url>/rest/export/<export_id>/download
Parameters
Expand parameters...
Parameter | Description | Required | Value Samples |
|---|
| export_id | The id of the file export that you want to query the information for | Yes | 341abae0-e277-4302-a6f9-cd7b5643ddef |
Examples
Expand examples...
https://tis.obss.io/rest/export/341abae0-e277-4302-a6f9-cd7b5643ddef/download
Responses
Expand responses...
Success
HTTP 200
Returns a file that contains the generated export data.
Export Not Found
HTTP 404
When an export with the given export_id is not found. The export_id might be invalid or the export might belong to another user.
{
"status": 404,
"message": "The export could not be found or you do not have permission to view it.",
"messages": null,
"pluginVersion": "1.18.0.1",
"time": "2020-03-19 05:24:48",
"exportId": "19f95f82-63ce-4d48-87d9-458c388d197a"
}
Export Not Completed
HTTP 404
When the export is in a state other than Successful. The export might still be in progress, might be aborted or might have failed.
{
"status": 404,
"message": "The export is not completed. It failed or is still being processed.",
"messages": null,
"pluginVersion": "1.18.0.1",
"time": "2020-03-19 05:28:52",
"exportId": "83246d2b-c833-4c01-b2a4-5077091f60c1"
}
