Get status of a single export

GET /rest/export/<export_id>

Details of a single file export in the system.

Request

XML

<service_url>/rest/export/<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	d57e59ca-568a-43a0-8baa-2b86a404d1fc

Example

Expand Examples...

XML

https://tis.obss.io/rest/export/d57e59ca-568a-43a0-8baa-2b86a404d1fc

Responses

Expand responses...

200 - Success

Success

HTTP 200

Returns a JSON that contains detailed information of a file export.

JS

{
    "exportId": "19f95f82-63ce-4d48-87d9-458c388d197b",
    "status": "Successful",
    "created": 1584595340656,
    "completed": 2,
    "total": 2,
    "message": null,
    "downloadLink": "https://tis.obss.io/rest/export/19f95f82-63ce-4d48-87d9-458c388d197b/download"
}

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

JS

{
    "status": 404,
    "message": "The export could not be found or you do not have permission to view it.",
    "messages": null,
    "pluginVersion": "1.18.0.1",
    "time": "2020-03-19 05:24:48",
    "exportId": "19f95f82-63ce-4d48-87d9-458c388d197a"
}

[data-colorid=iporxualdc]{color:#505050} html[data-color-mode=dark] [data-colorid=iporxualdc]{color:#afafaf}[data-colorid=tjhu4qf3oc]{color:#505050} html[data-color-mode=dark] [data-colorid=tjhu4qf3oc]{color:#afafaf}GET /rest/export/<export_id>

Request

Parameters

Example

Responses

GET /rest/export/<export_id>