This lists the actions available for the given model ID. 

The response comes in the form of a JSON array containing the list of actions that you can carry out, with the following values:

  • id is the Id of the action that you can carry out in the specified model.
  • actionType is the type of action contained in the model.
  • name is the name of the action that you can carry out. You can view these actions in the Anaplan user interface in the Action settings for the model.

Method and endpoint

GET

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

Parameters

ParameterDescription
workspaceId
  • Required
  • Type: string
  • Description: The workspace ID
  • Example: 8a8b8c8d8e8f8g8i
modelId
  • Required
  • Type: string
  • Description: The model ID
  • Example: 75A40874E6B64FA3AE0743278996850F

Curl example

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

Response

Response 200 (application/json)

{
   "meta": {
       "paging": {
           "currentPageSize": 11,
           "offset": 0,
           "totalSize": 11
       },
       "schema": "https://api.anaplan.com/2/0//models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "actions": [
       {
           "id": "117000000011",
           "actionType": "DELETE_BY_SELECTION",
           "name": "Delete From List Action"
       },
       {
           "id": "117000000010",
           "actionType": "ORDER_HIERARCHY",
           "name": "Order List Action"
       },
       {
           "id": "117000000009",
           "name": "Open Dashboard Action"
       },
       {
           "id": "117000000008",
           "actionType": "SIMPLE_CREATE",
           "name": "Create Action"
       },
       {
           "id": "117000000007",
           "actionType": "BULK_DELETE_ENTITIES",
           "name": "Delete Branch Action"
       },
       {
           "id": "117000000006",
           "actionType": "SELECT_CHILDREN",
           "name": "Assign Action"
       },
       {
           "id": "117000000005",
           "actionType": "UPDATE_CURRENT_PERIOD",
           "name": "Update Current Period Action"
       },
       {
           "id": "117000000003",
           "actionType": "BULK_ENTITY_COPY",
           "name": "Copy Branch Action"
       },
       {
           "id": "117000000004",
           "actionType": "COPY_TO_NUMBERED_LIST",
           "name": "Assign Only Action"
       },
       {
           "id": "117000000002",
           "actionType": "OPTIMIZER",
           "name": "Optimizer Action"
       },
       {
           "id": "117000000001",
           "actionType": "BULK_COPY",
           "name": "Bulk Copy Action Via Versions"
       }
   ]
}