Skip to navigation
API ReferenceChangeset

Retrieve Changeset status

Retrieve a Changeset by its unique ID.

A Changeset is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual Changesets are applied in a sequential fashion. If a Changeset causes a conflict or cannot be applied, it will be rejected. You can examine a Changeset to determine its conflict resolution status.

When checking the status of a Changeset, you can call either RetrieveChangeset or RetrieveCompletedChangeset. Using RetrieveChangeset will give you the immediate status of the Changeset. Using RetrieveCompletedChangeset will delay the response until the Changeset has finished processing.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

changeSetIdstringRequiredformat: "uuid"
The unique ID number of the Changeset to retrieve

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
dataobjectOptional
A ProjectChange is an individual edit that has been made to a project. Since multiple users can edit a project at the same time, individual ProjectChanges are applied in a sequential fashion. If a ProjectChange causes a conflict or cannot be applied, it will be rejected. You can examine a ProjectChange to determine its conflict resolution status.