Download an export file | OBSS Apps Documentation

GET /rest/tis/report/1.0/api/file/download

Downloads the file for a completed async file export operation.

Request

XML

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

XML

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

Responses

Expand responses...

200 - Success

Success

HTTP 200

Returns a file that contains the generated export data.

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 341abae0-e277-4302-a6f9-cd7b5643ddef 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:38:57"
}

404 - Export not completed

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.

{
    "message": "The report with id d6db17d3-40b6-4afd-a1f5-4b7639c4a08c is not completed. It is still being processed.",
    "statusCode": 404,
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:49:05"
}

404 - Export failed

Export Failed

HTTP 404

When the export is in a state other than Successful. The export might still be aborted or might have failed.

{
    "message": "The report with id d6db17d3-40b6-4afd-a1f5-4b7639c4a08c failed or is aborted.",
    "statusCode": 404,
    "messages": [
        "Report is aborted by user"
    ],
    "pluginVersion": "4.9.0.1",
    "time": "2020-09-04 16:51:54"
}