Anaplan
App · 19 actions
Connect Anaplan to automate models and integration tasks.
Actions
| Action | What it does |
|---|---|
| Get action | Gets one saved action in a model by its action ID, including its type and details. |
| Get export | Gets one export action in a model by its export ID, including its format and layout. |
| Get export task | Gets the progress of an export task by its task ID, including whether it finished, succeeded or failed. |
| Get import | Gets one import action in a model by its import ID, including its source file and target. |
| 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. |
| Get list metadata | Gets the setup of one list in a model by its list ID, including its properties, parent and item count. |
| 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. |
| List actions | Lists the other saved actions in a model, such as delete actions, with each action's ID and name. |
| List exports | Lists the saved export actions in a model, with each export's ID and name. |
| List file chunks | Lists the chunks a model's file is split into, by its file ID, with each chunk's ID and name. |
| List files | Lists the files in a model, the import data sources and export outputs, with each file's ID, name and chunk count. |
| List imports | Lists the saved import actions in a model, with each import's ID and name. |
| List lists | Lists the lists in a model, such as product or region hierarchies, with each list's ID and name. |
| List models | Lists the models in a workspace by its workspace ID, with each model's ID, name and state. |
| List processes | Lists the saved processes in a model, with each process's ID and name. |
| List workspaces | Lists the Anaplan workspaces the connected user can access, with each workspace's ID and name. |
| Start export | Starts a saved export in a model, using the locale you give. |
| Start import | Starts a saved import in a model, using the locale you give. |
| Start process | Starts 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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Action
action_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Export
export_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Export
export_idtextRequired - Export id for this request.
- Task id
task_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Import
import_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Import
import_idtextRequired - Import id for this request.
- Task id
task_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- List
list_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Process
process_idtextRequired - The saved process to start or inspect.
- Task id
task_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- File
file_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Export
export_idtextRequired - Export id for this request.
- Locale
localetextRequired - 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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Import
import_idtextRequired - Import id for this request.
- Locale
localetextRequired - 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
- Workspace
workspace_idtextRequired - Workspace id for this request.
- Model
model_idtextRequired - Model id for this request.
- Process
process_idtextRequired - The saved process to start or inspect.
- Locale
localetextRequired - 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
}