Use this call to start a task that generates a summary report between two model revisions.

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.

You must be a Workspace Administrator for both the target and source model workspaces. Additionally, ensure you have access privileges to both 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.

POST

https://api.anaplan.com/2/0/models/{targetModelId}/alm/summaryReportTasks

ParameterDetails
targetModelIdThe ID of the model for the target revision

curl -X POST 'https://api.anaplan.com/2/0/models/{targetModelId}/alm/summaryReportTasks' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
 "sourceRevisionId": "<revision_to_sync>",
 "sourceModelId": "<source_model_id>",
 "targetRevisionId": "<latest_revision_on_target_model>"
}'

If your response is successful, you receive a 201 "Created" HTTP status with a response body.

  • Content-Type: application/json
  • Location: <URL of the created summary report generated task>

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/taskWithUrl"
   },
   "status": {
       "code": 201,
       "message": "Created"
   },
   "task": {
       "taskId": "6C283D93A9E64570BF502B8F7AF67A00",
       "taskUrl": "https://api.anaplan.com/2/0/models/7282C939A7F54B9A88CB39920592F338/alm/summaryReportTasks/6C283D93A9E64570BF502B8F7AF67A00",
       "taskState": "IN_PROGRESS",
       "creationTime": 1614618651855
   }
}

Review the ALM API troubleshooting guide to resolve any error responses from API calls.