DELETE /rest/export/<export_id>
Abort a running file export.
Request
<service_url>/rest/export/<export_id>
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
Responses
Expand responses...
Success
HTTP 200
Returns a JSON that contains information about the aborted export.
{
"exportId": "c70f9366-f0e7-48f2-8a3b-264bc3fb3903",
"status": "Aborted",
"created": 1584595881543,
"completed": 1,
"total": 237,
"message": null
}
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 Already Completed
HTTP 404
The file export was not aborted because the export was completed before the abort command was received by the process.
{
"status": 404,
"message": "The export is completed.",
"messages": null,
"pluginVersion": "1.18.0.1",
"time": "2020-03-19 05:31:58",
"exportId": "c70f9366-f0e7-48f2-8a3b-264bc3fb3903"
}
