Use this call to check on the progress or final results of a specific synchronization task. 

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.  

GET

https://api.anaplan.com/2/0/models/{modelId}/alm/syncTasks/{syncTaskId} 

Path parameter Description 
modelId Required. The ID of the target model. 
syncTaskId Required. The ID of the target sync task resource. 

curl -X GET "https://api.anaplan.com/2/0/models/{modelId}/alm/syncTasks/{syncTaskId}" \
 -H "Authorization: AnaplanAuthToken {anaplan_auth_token}"

This API call returns HTTP 200 OK response for both the sync task completing successfully and failing.

{
 "meta": {
   "schema": "https://api.anaplan.com/2/0/objects/task"
 },
 "status": {
   "code": 200,
   "message": "Success"
 },
 "task": {
   "taskId": "48B7FB976E8F4FBDAD925EC90BADB4FC",
   "currentStep": "Complete.",
   "result": {
     "successful": true
   },
   "taskState": "COMPLETE",
   "creationTime": 1614870183373
 }
} 

If the task encountered errors during run-time execution, status 200 is still returned, but complete failure details reside within the nested error block: 

{
 "meta": {
   "schema": "https://api.anaplan.com/2/0/objects/task"
 },
 "status": {
   "code": 200,
   "message": "Success"
 },
 "task": {
   "taskId": "9CF4E79BC78348539A5D994C18A8A18E",
   "currentStep": "Failed.",
   "result": {
     "successful": false,
     "error": {
       "title": "Model Synchronization Failed",
       "messageText": "Your current workspace size is 998.9 MB. The current size of the model is 440.3 MB, but would be 552.9 MB after sync.",
       "subtitle": "Completing this sync would cause your workspace to exceed its size limit of 1.0 GB."
     }
   },
   "taskState": "COMPLETE",
   "creationTime": 1615387609842
 }
} 

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