Checks task execution and provides the direct resource URL for the raw file once processing completes.
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 for both the target and source model workspaces. Additionally, ensure you have access privileges to both models.
Method and Endpoint
/models/{modelId}/alm/comparisonReportTasks/{taskId}
Parameters
| Parameter | Location | Required | Description |
modelId | Path | Yes | The target model's unique identifier. |
taskId | Path | Yes | The report generation task identifier. |
CURL Example
curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/alm/comparisonReportTasks/{taskId}' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
Response
This API call returns a 200 OK code for a successful response.
{
"meta": {
"schema": "https://api.anaplan.com/2/0/objects/syncTask"
},
"status": {
"code": 200,
"message": "Success"
},
"task": {
"taskId": "48B7FB976E8F4FBDAD925EC90BADB4FC",
"currentStep": "Complete.",
"result": {
"successful": true,
"targetRevisionId": "795731A31D1A47EFB3802EA6355C62C4",
"sourceRevisionId": "E7F72A49B23C43638DC77839D78B33BE",
"reportFileUrl": "https://api.anaplan.com/2/0/models/{modelId}/alm/comparisonReports/795731A31D1A47EFB3802EA6355C62C4/E7F72A49B23C43638DC77839D78B33BE"
},
"taskState": "COMPLETE",
"creationTime": 1614870183373
}
}
Review the ALM API troubleshooting guide to resolve any error responses from API calls.