Abort an export | OBSS Apps Documentation

Overview

DELETE /rest/export/<export_id>

Abort a running file export.

Required Permissions

All Users with Timepiece access can abort their own running file exports.

Request

DELETE <service_url>/rest/export/<export_id>

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

Example Requests

DELETE https://tis.obss.io/rest/export/341abae0-e277-4302-a6f9-cd7b5643ddef

Response

Example Response Body

JSON

{
    "exportId": "c70f9366-f0e7-48f2-8a3b-264bc3fb3903",
    "status": "Aborted",
    "created": 1584595881543,
    "completed": 1,
    "total": 237,
    "message": null
}

Response Codes

200 OK: Returns a JSON that contains information about the aborted export.
404 Export Not Found: 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.
404 Export Already Completed: The file export was not aborted because the export was completed before the abort command was received by the process.