Use to retrieve details about a specific action and usage context.

Method and endpoint

GET

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

Parameters

ParameterRequiredTypeDescriptionExample
workspaceIdYesstringThe workspace ID8a8b8c8d8e8f8g8i
modelIdYesstringThe model ID75A40874E6B64FA3AE0743278996850F
actionIdYesstringThe action ID117000000019

Curl example

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

Response

Response 200 for a delete from list action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000011",
       "listId": "101000000015",
       "filterLineItemId": "503000000001",
       "actionType": "DELETE_BY_SELECTION",
       "name": "Delete From List Action"
   }
}

Response 200 for order list action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000010",
       "listId": "101000000004",
       "sortOrder": "Descending",
       "lineItemId": "411000000002",
       "actionType": "ORDER_HIERARCHY",
       "name": "Order List Action"
   }
}

Response 200 for open dashboard action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000009",
       "name": "Open Dashboard Action"
   }
}

Response 200 for create action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000008",
       "actionType": "SIMPLE_CREATE",
       "name": "Create Action"
   }
}

Response 200 for delete branch action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000007",
       "actionType": "BULK_DELETE_ENTITIES",
       "name": "Delete Branch Action"
   }
}

Response 200 for assign action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000006",
       "actionType": "SELECT_CHILDREN",
       "name": "Assign Action"
   }
}

Response 200 for update current period

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000005",
       "actionType": "UPDATE_CURRENT_PERIOD",
       "name": "Update Current Period Action"
   }
}

Response 200 for copy branch action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000003",
       "actionType": "BULK_ENTITY_COPY",
       "name": "Copy Branch Action"
   }
}

Response 200 for assign only action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000004",
       "actionType": "COPY_TO_NUMBERED_LIST",
       "name": "Assign Only Action"
   }
}

Response 200 for Optimizer action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000002",
       "actionType": "OPTIMIZER",
       "name": "Optimizer Action"
   }
}

Response 200 for bulk copy action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000001",
       "targetMember": "107000000002",
       "listId": "9000000002",
       "sourceMember": "107000000001",
       "actionType": "BULK_COPY",
       "name": "Bulk Copy Action Via Versions"
   }
}

Response 200 for a long action name (max. 60 chars) with special characters

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000001",
       "targetMember": "107000000002",
       "listId": "9000000002",
       "sourceMember": "107000000001",
       "actionType": "BULK_COPY",
       "name": "longactionname±!@£$%^&*💖}{\\\":<?>±!@£$%^?éâîôñ\\\"~`-=\\\\'./,]["
   }
}

Response 200 for update current period action

{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000005",
       "actionType": "UPDATE_CURRENT_PERIOD",
       "name": "Update Current Period Action"
   }
}

{
   "meta": {
       "schema": "https://api.r2p2.anaplan.com/2/0/models/CB6CD83523D84EC8803E29DBAD5CF1E1/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000010",
       "sortOrder": "Descending",
       "listId": "101000000004",
       "lineItemId": "",
       "actionType": "ORDER_HIERARCHY",
       "name": "Order List Action"
   }
}

Response 404 for invalid action Id

{
   "status": {
       "code": 404,
       "message": "Not Found"
   },
   "path": "/2/0/workspaces/e4c0824a889f59d601889f5f236b0001/models/F7F3D1004C214A00A44C1655DE413B50/actions/33",
   "timestamp": "2023-06-09T12:07:17.659388Z"
}

Group delete actions

View these endpoints for further details on delete actions APIs:

You can use this API to automate ‌the removal of specific items from a list using the 'Delete from List Using Selection' functionality in Anaplan.

Tip: To use this functionality, a proper 'Delete from list Using Selection' action must exist in the model that you want to delete from a list. You can create a control module to select the items to be deleted from the list and then create a 'Delete from List using Selection' action. See Delete from List using Selection for further information.

To carry out a delete operation using the API:

  1. Verify that the delete action is available.
  2. Run the delete action.
  3. Get a list of deletion tasks and monitor each deletion task.