Abort an export | OBSS Apps Documentation

DELETE /rest/tis/report/1.0/api/file/

Abort a running async file export.

Request

XML

<jira_url>/rest/tis/report/1.0/api/file/<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...

XML

https://192.168.0.1/rest/tis/report/1.0/api/file/341abae0-e277-4302-a6f9-cd7b5643ddef

Responses

Expand responses...

200 - Success

Success

HTTP 200

Returns a JSON that contains information about the aborted export.

{
    "exportId": "b841b270-77b6-41d8-9d4f-25c48211a49c",
    "created": "24/Aug/20 5:35 PM",
    "completed": 1,
    "total": 23,
    "status": "Aborted By User"
}

404 - Export not found

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.

{
    "message": "The export with id 3c2099ce-3874-4812-ad95-e8fecfdff821 could not be found or you do not have permission to view it.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:52:32"
}

404 - Export already completed

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.

{
    "message": "Could not abort since the report has already completed",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:32:54"
}