Use this call to retrieve the names and actions for a given Process in an Anaplan model.

Note:

  • Actions which are imports or exports (actionType field is IMPORT or EXPORT) contain additional fields in the response (see below). Other actions just contain the id, name, and actionType.
  • Actions are ordered in the sequence that they run when the Process itself is executed.
  • For an action with actionType of IMPORT, you can use the importDataSourceId value as the ID of a file for the fileId parameter when you upload or download files.
  • For actions with actionType of EXPORT or IMPORT, you can find more information about them if you use the IDs as exportId or importId in the export and import metadata endpoints.
  • The possible values for actionType (non-exhaustive list):
    • IMPORT
    • EXPORT
    • DELETE_BY_SELECTION
    • ORDER_HIERARCHY
    • OPTIMIZER
  • To include additional information regarding the import data source in an import action, add the ?showImportDataSource=true query parameter to the request.


Method and endpoint

GET

/models/{modelId}/processes/{processId}

Parameters

ParameterDetails
{modelId}
  • Required
  • Type: String
  • Description: the ID for the model
  • Example: 75A40874E6B64FA3AE0743278996850F
{processId}
  • Required
  • Type: Number
  • Description: the ID for the process
  • Example: 118000000001
  • Note that you can get the process ID from the list of process for a model API
{showImportDataSource}
  • Optional
  • Type: Boolean
  • Description: defines whether the response should include additional information regarding the import data source. The field is interpreted as false if anything other than true is specified.
  • Example: ?showImportDataSource=true

Curl example

curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/processes/{processId}' \
-H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'\
-H 'Accept: application/json'

Response

Response headers

Content-Type: application/json

Response 200 Body

{
 "meta": {
   "schema": "https://api.anaplan.com/2/0/objects/process"
 },
 "status": {
   "code": 200,
   "message": "Success"
 },
 "processMetadata": {
   "name": "ProcessWithActions",
   "actions": [
     {
       "id": "112000000000",
       "name": "Sales from import-sales.csv",
       "actionType": "IMPORT",
       "importDataSourceId": "113000000000",
       "importType": "MODULE_DATA",
       "importDataSource": {
         "importDataSourceId": "113000000000",
         "type": "FILE"
       }
     },
     {
       "id": "116000000000",
       "name": "Sales - Revenue.xls",
       "actionType": "EXPORT",
       "exportType": "GRID_CURRENT_PAGE",
       "exportFormat": "application/vnd.ms-excel",
       "layout": "GRID_CURRENT_PAGE"
     },
     {
       "id": "117000000000",
       "name": "Delete from Products",
       "actionType": "DELETE_BY_SELECTION"
     }
   ]
 }
}