Get Export Job

Retrieves an export job by ID. For detailed usage, file format specifications, and field references, see the Import/Export API Overview.

GET /platform/data/export/{id}

Error

A valid request URL is required to generate request examples

200

{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "configuration": null,
  "contextOverride": {
    "catalog": 123,
    "currency": "<string>",
    "locale": "<string>",
    "masterCatalog": 123,
    "site": 123
  },
  "domain": "<string>",
  "exportDate": "2023-11-07T05:31:56Z",
  "files": [
    {
      "fileName": "<string>",
      "fileType": "<string>",
      "id": "<string>",
      "locationType": "<string>",
      "uri": "<string>"
    }
  ],
  "format": "<string>",
  "id": "<string>",
  "isComplete": true,
  "name": "<string>",
  "requester": "<string>",
  "resources": [
    {
      "configuration": null,
      "fields": [
        "<string>"
      ],
      "filter": "<string>",
      "format": "<string>",
      "isComplete": true,
      "resource": "<string>",
      "stateDetails": "<string>",
      "status": "<string>",
      "statusMessage": "<string>"
    }
  ],
  "status": "<string>",
  "statusDetails": "<string>",
  "statusMessage": "<string>",
  "tenant": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

id · string · required

Query Parameters

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

auditInfo · object

Show child attributes

configuration · unknown

contextOverride · object

Show child attributes

domain · string | null

exportDate · string<date-time> | null

files · object[] | null

Show child attributes

format · string | null

id · string | null

isComplete · boolean

name · string | null

requester · string | null

resources · object[] | null

Show child attributes

status · string | null

statusDetails · string | null

statusMessage · string | null

tenant · integer<int32>