Anaplan

App · 19 actions

Connect Anaplan to automate models and integration tasks.

Actions

ActionWhat it does
Get actionGets one saved action in a model by its action ID, including its type and details.
Get exportGets one export action in a model by its export ID, including its format and layout.
Get export taskGets the progress of an export task by its task ID, including whether it finished, succeeded or failed.
Get importGets one import action in a model by its import ID, including its source file and target.
Get import taskGets the progress of an import task by its task ID, including whether it finished, succeeded or failed and its result details.
Get list metadataGets the setup of one list in a model by its list ID, including its properties, parent and item count.
Get process taskGets the progress of a process task by its task ID, including whether it finished, succeeded or failed and the result of each step.
List actionsLists the other saved actions in a model, such as delete actions, with each action's ID and name.
List exportsLists the saved export actions in a model, with each export's ID and name.
List file chunksLists the chunks a model's file is split into, by its file ID, with each chunk's ID and name.
List filesLists the files in a model, the import data sources and export outputs, with each file's ID, name and chunk count.
List importsLists the saved import actions in a model, with each import's ID and name.
List listsLists the lists in a model, such as product or region hierarchies, with each list's ID and name.
List modelsLists the models in a workspace by its workspace ID, with each model's ID, name and state.
List processesLists the saved processes in a model, with each process's ID and name.
List workspacesLists the Anaplan workspaces the connected user can access, with each workspace's ID and name.
Start exportStarts a saved export in a model, using the locale you give.
Start importStarts a saved import in a model, using the locale you give.
Start processStarts a saved process in a model, which runs its actions in order, using the locale you give.

Get action

Gets one saved action in a model by its action ID, including its type and details.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Actionaction_idtextRequired
Action id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get export

Gets one export action in a model by its export ID, including its format and layout.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Exportexport_idtextRequired
Export id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get export task

Gets the progress of an export task by its task ID, including whether it finished, succeeded or failed.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Exportexport_idtextRequired
Export id for this request.
Task idtask_idtextRequired
Task id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get import

Gets one import action in a model by its import ID, including its source file and target.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Importimport_idtextRequired
Import id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get import task

Gets the progress of an import task by its task ID, including whether it finished, succeeded or failed and its result details.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Importimport_idtextRequired
Import id for this request.
Task idtask_idtextRequired
Task id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get list metadata

Gets the setup of one list in a model by its list ID, including its properties, parent and item count.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Listlist_idtextRequired
List id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get process task

Gets the progress of a process task by its task ID, including whether it finished, succeeded or failed and the result of each step.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Processprocess_idtextRequired
The saved process to start or inspect.
Task idtask_idtextRequired
Task id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List actions

Lists the other saved actions in a model, such as delete actions, with each action's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List exports

Lists the saved export actions in a model, with each export's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List file chunks

Lists the chunks a model's file is split into, by its file ID, with each chunk's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Filefile_idtextRequired
File id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List files

Lists the files in a model, the import data sources and export outputs, with each file's ID, name and chunk count.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List imports

Lists the saved import actions in a model, with each import's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List lists

Lists the lists in a model, such as product or region hierarchies, with each list's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List models

Lists the models in a workspace by its workspace ID, with each model's ID, name and state.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List processes

Lists the saved processes in a model, with each process's ID and name.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

List workspaces

Lists the Anaplan workspaces the connected user can access, with each workspace's ID and name.

Inputs

None.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Start export

Starts a saved export in a model, using the locale you give. Returns the task ID to check its progress with Get export task.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Exportexport_idtextRequired
Export id for this request.
LocalelocaletextRequired
Locale for this request.One of: en_US, en_GB, de_DE, fr_FR, es_ES, it_IT, ja_JP.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Start import

Starts a saved import in a model, using the locale you give. Returns the task ID to check its progress with Get import task.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Importimport_idtextRequired
Import id for this request.
LocalelocaletextRequired
Locale for this request.One of: en_US, en_GB, de_DE, fr_FR, es_ES, it_IT, ja_JP.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Start process

Starts a saved process in a model, which runs its actions in order, using the locale you give. Returns the task ID to check its progress with Get process task.

Inputs

Workspaceworkspace_idtextRequired
Workspace id for this request.
Modelmodel_idtextRequired
Model id for this request.
Processprocess_idtextRequired
The saved process to start or inspect.
LocalelocaletextRequired
Locale for this request.One of: en_US, en_GB, de_DE, fr_FR, es_ES, it_IT, ja_JP.

Outputs

dataobject
The service response, including all records and metadata.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

On this page