Downloads raw, tab-delimited structural details for the requested revisions. Generated comparison files expire 48 hours after generation.
For best performance and outcomes, make all API calls to your closest regional server. To learn more about this, read URL, IP, and allowlist requirements.
Note: You must be a workspace administrator and you must have access to the specified model.
Method and Endpoint
/models/{modelId}/alm/comparisonReports/{targetRevisionId}/{sourceRevisionId}
Curl example
curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/alm/comparisonReports/{targetRevisionId}/{sourceRevisionId}' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
The server returns a raw binary/text file stream rather than JSON.
Content-Type: application/octet-stream
Response body format
Source Workspace ff8081813f9aee3c013f9b06a28a000a Name
Source Model StarterModel
Source Revision rev2 null
Target Workspace ff8081813f9aee3c013f9b06a28a000a Name
Target Model StarterModel
Target Revision rev1 null
=== LISTS ADDED ===
Name Position Relative To Has Workflow Is Numbered List Is Organisation Notes Is Production Data Has Selective Access Use Top Level As Default Page
Products End - false false false - false false
=== MODULES ADDED ===
Name Position Relative To Applies To Breakback Time Scale Notes Read Access Driver Read/Write Access Driver Time Range Users List Option Versions
Products over time End - Products New Line Items: Off Month - - - Model Calendar Show All Users: On Not Applicable
The response is a plain-text, tab-separated metadata comparison report that details workspace coordinates. It also has sections that highlight new lists and modules and their configuration properties.
Note: In the actual response, columns are separated by tabs rather than spaces.