GET /rest/export
A detailed list of file exports in the system.
Supports paging
Request
<service_url>/rest/export
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 |
Examples
Expand examples...
https://tis.obss.io/rest/export
https://tis.obss.io/rest/export?pageNumber=10&pageSize=5
Responses
Expand responses...
Success
HTTP 200
Returns a JSON that contains all file exports of your instance, running or completed.
{
"pageNumber": 0,
"pageSize": 100,
"total": 3,
"isLast": true,
"exports": [
{
"exportId": "3f70d7bb-e05d-4658-9d2f-a9f9fac27396",
"status": "Successful",
"created": 1584536558826,
"completed": 2,
"total": 2,
"message": null,
"downloadLink": "https://tis.obss.io/rest/export/3f70d7bb-e05d-4658-9d2f-a9f9fac27396/download"
},
{
"exportId": "461d1869-866b-488e-baee-bda342aecc67",
"status": "Aborted",
"created": 1584540713594,
"completed": 22,
"total": 237,
"message": "Report processing was cancelled by the user"
},
{
"exportId": "532dad94-6776-4f02-9002-534c31563e9d",
"status": "Aborted",
"created": 1584607355618,
"completed": 1,
"total": 237,
"message": "Report processing was cancelled by the user"
}
]
}
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": "1.18.0.1",
"time": "2020-03-19 11:55:26"
}
