/changedEntityExportJobs

Create a new Changed Entity Export Job

Use this endpoint to request a new Changed Entity Export Job for a specified resourceType with properties provided in the request body. The generated dataset will be one or multiple files that include all records which have changed between dateChangedFrom (specified by the user) and dateChangedTo (generated by the server at execution). Optionally, the user may also specify that inactive records be included in the export file with the includeInactive property. ChangeTypes began being stored in September 2020. Records for which the last change occurred before this date may be missing inaccurate ChangeTypes until they are updated. The user may also specify additional IDs with the requestedIds property to add to the dataset. The exported data will include all core fields for the resource type as well as any specified by the user with the requestedFields or requestedCustomFieldIds properties. If all generated content is less than the fileSizeKbLimit, then one file will be created. Otherwise, multiple files will be created such that none exceeds the specified limit.

If the dateChangedTo parameter is in the past, the resulting records will be any which changed in the dateChangedFrom and dateChangedTo window. However, the records that will be returned by the job will always be the current version of the records. They will not be records at the snapshot moment in time of dateChangedTo.

File download links expire after 20 days.

Response

If successful, the endpoint responds with HTTP Status Code 201 Created and the integer ID of the created export job in the response body. It will also return all the requested properties. Any missing properties in the response indicates that they were not accepted and will not be processed.

Note that dateChangedFrom value from the user may be expressed as Z Zulu Time (UTC -00:00) or a time offset, such as +02:00.

The following is an example of a completed Changed Entity Export Job:

{
  "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,
  "excludeChangesFromSelf": "true"
}

Property

Type

Description

exportJobId

long

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. Must be in the last 90 days.

dateChangedTo

date

User-specified timestamp in same format as dateChangedFrom. Server-generated if not provided.

files

array

Collection of file objects in the format [ { downloadUrl, dateExpired } ]

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

excludeChangesFromSelf

bool

If true, records updated in EveryAction by requesting API user will not be exported. This option could be used to prevent “circular updates” in bidirectional integrations where the same API key is used for both pulling changes and applying changes

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