Retrieve Completed Changeset status
Retrieve a Changeset by its unique ID. This endpoint waits for the Changeset to complete its
processing prior to returning a result.
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.
Although most Changesets complete instantly, some Changesets may need additional time to
complete. If the Changeset cannot be processed within a reasonable length of time, this API
call may fail. If this API fails, it will return a status error indicating the Changeset is
still being processed.
Path parameters
changeSetId
The unique ID number of the Changeset to retrieve
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-integration-name
The name of the calling system passed along as a header parameter
Response
Success
error
If the API call failed, this will contain information about the error that occurred.
success
True if the API call succeeded; false otherwise.
hasError
True if the API call failed.
statusCode
The HTTP code of the response.
data
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.