Get status of a single export

Overview

GET /rest/export/<export_id>

Details of a single file export in the system.

Required Permissions

All Users with Timepiece access can retrieve details of their own single-file exports in the system.

Request

NONE

GET <service_url>/rest/export/<export_id>

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 Requests

NONE

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

Response

Example Response Body

JSON

{
    "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"
}

Response Codes

200 OK: Returns a JSON that contains detailed information of a file export.
404 Export Not Found: 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.