Use it to initiate the deletion process for a specified resource or entity.

Method and endpoint

POST

/workspaces/{workspaceId}/models/{modelId}/actions/{actionId}/tasks

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
actionId
  • Required
  • Type: number
  • Description: The ID for the Delete action.
  • Example: 117000000019

Curl example

curl -X POST \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/actions/{actionId}/tasks \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}'\
-H 'Content-Type:application/json' \
-d '{"localeName": "en_US"}'

Response

Response 200 (application/json)

{
   "task":{
      "taskId":"0690AA1C761F48549C3442A02F91D962"
   }
}

Get a list of deletion tasks

Request

curl -X GET \
https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/actions/{actionId}/tasks \
-H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
-H 'Content-Type:application/json'

Headers

  • Authorization:AnaplanAuthToken {anaplan_auth_token}
  • Content-Type:application/json

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F
actionId
  • Required
  • Type: number
  • Description: The ID for the Delete action.
  • Example: 117000000019

Response 200 (application/json)

{
   "tasks":[
      {
         "taskId":"F37EA1512BC448D3B223431C33B844B6",
         "taskState":"COMPLETE",
         "creationTime":1535145589808
      }
   ]
}