Use this endpoint to retrieve a summary report that shows how many structural changes there are between a source model revision and a target model revision.
The report gives a total count of objects created, modified and deleted, and breaks those counts down by object type, such as lists, modules and line items. Use it to get a quick view of the size and scope of the changes before you sync two models.
Note: This is one of three steps. First, start the task with the Create a summary report generation task endpoint. Then call the Retrieve summary report content endpoint until the task is complete. Finally, retrieve the report from the reportFileUrl in the result with the Retrieve the contents for a summary report endpoint.
Method and endpoint
/models/{modelId}/alm/summaryReports/{targetRevisionId}/{sourceRevisionId}
Parameters
| Path parameter | Details |
modelId | String. Required. The ID of the target model. |
targetRevisionId | String. Required. The ID of the target revision. This is usually the latest revision on the target model. |
sourceRevisionId | String. Required. The ID of the source revision that you are comparing with the target revision. |
Curl example
curl -X GET 'https://api.anaplan.com/2/0/models/7282C939A7F54B9A88CB39920592F338/alm/summaryReports/E7E7D6A8916C429590E9DA900467C452/8ABF264A02D24948B786D5B0BDE146D7' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
Response
All responses have the header Content-Type: application/json.
200 OK
The report was found. In this example, one line item, one list and one module were created, one list was deleted, and the contents of one role were modified.
{
"meta": {
"schema": "https://api.anaplan.com/2/0/objects/summaryReport"
},
"status": {
"code": 200,
"message": "Success"
},
"summaryReport": {
"targetRevisionId": "E7E7D6A8916C429590E9DA900467C452",
"sourceRevisionId": "8ABF264A02D24948B786D5B0BDE146D7",
"totals": {
"modified": 1,
"deleted": 1,
"created": 3
},
"differences": {
"lineItems": {
"created": 1
},
"rolesContents": {
"modified": 1
},
"lists": {
"deleted": 1,
"created": 1
},
"modules": {
"created": 1
}
}
}
}
Response body elements
| Element | Type | Details |
summaryReport.targetRevisionId | String | The ID of the target revision. |
summaryReport.sourceRevisionId | String | The ID of the source revision. |
summaryReport.totals | Object | The total number of objects created, modified and deleted across all object types. |
summaryReport.differences | Object | The counts for each type of object that changed. Each key is an object type, for example lists, modules, lineItems or rolesContents. Types with no changes are left out. |
summaryReport.differences.{objectType}.created | Integer | The number of objects of this type that were created. Left out if zero. |
summaryReport.differences.{objectType}.modified | Integer | The number of objects of this type that were modified. Left out if zero. |
summaryReport.differences.{objectType}.deleted | Integer | The number of objects of this type that were deleted. Left out if zero. |