/changedEntityExportJobs/{exportJobId}

This endpoint returns status and metadata about an existing Changed Entity Export Job, which is specified by the unique identifier exportJobId.

Response

Returns metadata about a ChangedEntityExportJob object, if found.

{
  "exportJobId": 12345,
  "jobStatus": "Complete",
  "dateChangedFrom": "2019-01-01T01:02:03+04:00",
  "dateChangedTo": "2019-01-01T07:03:09+04:00",
  "files": [
    {
      "downloadUrl": "https://www.example.com/some-unique-file-name.csv",
      "dateExpired": "2019-01-31T15:05:54.2106809-04:00"
    }
  ],
  "message": "Finished processing export job",
  "code": null,
  "exportedRecordCount": 10500
}

Property

Type

Description

exportJobId

int

Unique identifier for a Changed Entity Export Job

jobStatus

string

Pending, InProcess, Error, Complete

dateChangedFrom

date

User-specified timestamp in the format YYYY-MM-DDThh:mm:ss.00Z or YYYY-MM-DDThh:mm:ss.00 -hh:mm

dateChangedTo

date

Server-generated timestamp in the format YYYY-MM-DDThh:mm:ss.00 -hh:mm

files

array

Collection of file objects in the format [ { downloadUrl, dateExpired } ]. File access expires after 24 hours.

message

string

Additional information about the job status

code

string

null if there is no error, otherwise a reference code for debugging

exportedRecordCount

int

The number of records contained across all export files

If the specified exportJobId is inaccessible or does not exist, this endpoint will return an error with HTTP Status Code 404 Not Found.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!