Get status of all exports | OBSS Apps Documentation

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

A detailed list of async file exports in the system.

Supports paging

Request

XML

<jira_url>/rest/tis/report/1.0/api/file

Parameters

Expand parameters...

Parameter	Description	Required
pageNumber	The page index to start at, when paging is employed. Works with zero-based index so pageNumber for the first page is 0. The default value is 0.	No
pageSize	The maximum number of items in a page. The default is 100 and values greater than 100 will be processed as 100	No

Parameter

Description

Required

pageNumber

The page index to start at, when paging is employed.

Works with zero-based index so pageNumber for the first page is 0.

The default value is 0.

pageSize

The maximum number of items in a page.

The default is 100 and values greater than 100 will be processed as 100

Examples

Expand examples...

XML

https://192.168.0.1/rest/tis/report/1.0/api/file

https://192.168.0.1/rest/tis/report/1.0/api/file?pageNumber=10&pageSize=5

Responses

Expand responses...

200 - Success

Success

HTTP 200

Returns a JSON that contains all file exports of your instance, running or completed.

{ "pageNumber": 2, "pageSize": 5, "totalExportCount": 24, "last": false, "exports": [ { "exportId": "6a5c3529-af63-44e1-a17c-d3546b135db0", "created": "24/Aug/20 5:21 PM", "completed": 23, "total": 23, "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download", "status": "Successful" }, { "exportId": "abdcd876-b45e-4815-8f01-cdf20fd1fd0a", "created": "24/Aug/20 5:14 PM", "completed": 23, "total": 23, "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download", "status": "Successful" }, { "exportId": "09db197c-54d7-4409-a7d8-31be0f927dc4", "created": "24/Aug/20 5:11 PM", "completed": 23, "total": 23, "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download", "status": "Successful" }, { "exportId": "2e602b9a-9183-4042-84de-1a06ccb7d43d", "created": "24/Aug/20 4:56 PM", "message": "Report is aborted by user", "status": "Aborted By User" }, { "exportId": "7916057a-c22c-4ea1-a371-2c72059472b2", "created": "24/Aug/20 4:45 PM", "completed": 23, "total": 23, "downloadLink": "https://192.168.0.1/rest/tis/report/1.0/api/file/download", "status": "Successful" } ] }

400 - Invalid parameters

Invalid Paging Parameters

HTTP 400

When at least one of the providedg pagin parameters contain an invalid value.

{ "status": 400, "message": "Invalid paging parameters.", "messages": [ "For input string: \"two\"" ], "pluginVersion": "4.9.0.1", "time": "2020-09-04 16:17:23" }