GetExportDataJob

GET /tp-api/exports

Retrieve the status and download url of a specific export data job.

Query Parameters

• id string required

  Job ID

Responses

• 200
• 400

---

Default Response

application/json

Schema

Schema

• job object required

  id string required

  Job ID.

  status string required

  Possible values: [PENDING, COMPLETED, FAILED]

  Job Status

• exportData object required

  downloadUrl object required

  anyOf

  MOD1

  string

  Url for downloading the file.

• downloadExpiresAt object required

  anyOf

  MOD1

  string

  Expiry time for the file in UTC.

errors object[] required

Array [

key string

message string required

]

{
  "job": {
    "id": "string",
    "status": "PENDING"
  },
  "exportData": {
    "downloadUrl": "string",
    "downloadExpiresAt": "string"
  },
  "errors": [
    {
      "key": "string",
      "message": "string"
    }
  ]
}

Default Response

application/json

Schema

Schema

• anyOf
  MOD1
• statusCode number required
• code string

  Error code

• error string required

  Error key

• message string required

  Error message

error object required

key string required

Error key

message string required

Error message

{
  "statusCode": 0,
  "code": "string",
  "error": "string",
  "message": "string"
}