get
https://COMPANY.my.bluecanvas.io/apis/rest/v1/compare
Lists the files that differ between two refs, as a deployment from the source into the target would see them.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Lists the metadata files that differ between two refs. status is what deploying the source into the target would do to the file: ADD, MODIFY or DELETE.
Profiles and Permission Sets are not listed here; see List deployable permissions.
Paging
Without limit the whole list is returned in one response. With limit the list is paged: meta.hasNext says whether another page exists and meta.next is its URL. total always counts every match, whatever the page.
Two unrelated orgs can differ in more than 100,000 files, so pass limit, or narrow the comparison with path, whenever the refs may be far apart.
Response fields
| Field | Description |
|---|---|
sourceCommit, targetCommit | The commits the two refs resolved to. |
incompatible | true when the two branches use different source formats and cannot be deployed between. |
total | Files that differ (under path, if given), across all pages. |
files[].path | Repository path of the file. |
files[].status | ADD, MODIFY or DELETE. |
