Articles in this section

Available Anaplan APIs

When you configure an export, import, other type of flow step using the prebuilt Anaplan connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Anaplan API documentation. You can also create a composite endpoint for this application in HTTP mode.

API type: Integration

Resource

API endpoint

Export

Import

Compatibility check

Retrieve compatible source model revisions

X

Retrieve the models for a specific revision

X

Delete actions

List model actions

X

Start deletion action

X

Monitor deletion task

X

Download files for actions

Get export and import file list

X

Get file chunks

X

Get chunk data

X

Delete file

X

Export actions

List available export definitions

X

Get export definition metadata

X

Start export task

X

Monitor export task

X

Full comparison report

Create comparison report generation task

X

Retrieve comparison report

X

Retrieve comparison report generation task

X

Import actions

Get import IDs

X

Start import task

X

Get import tasks

X

Monitor import task

X

Get dump chunk count for failed import

X

Download dump file chunk

X

Get metadata for an import definition

X

Line items

Retrieve line item dimensions

X

Retrieve dimension IDs for a line item

X

Retrieve all line item metadata in a model

X

Retrieve all line item metadata in a module

X

Retrieve selected items in a dimension

X

Retrieve dimension items for line item

X

Model

Change a model's online status

X

Close model

X

Wake up model

X

Model actions

Get model actions

X

Get action metadata

X

Model calendar

Retrieve current period

X

Set current period

X

Get current fiscal year

X

Update current fiscal year

X

Model lists

Retrieve lists

X

Get list details

X

Retrieve list data

X

Add list items

X

Update list items

X

Delete list items

X

Reset list index

X

Model sync task

Create a model sync task

X

Retrieve model sync task info

X

Retrieve sync tasks for a model

X

Models

Retrieve models

X

Retrieve a specific model

X

Bulk delete models

X

Check model status

X

Retrieve version metadata

X

Set version switchover date

X

Modules and views

Retrieve modules in a model

X

Retrieve views in a model

X

Retrieve views in a module

X

Retrieve view dimensions metadata

X

Retrieve cell data for a view

X

Other model metadata

Lookup dimension items by name or code

X

Retrieve all items in a dimension

X

Retrieve selected items in a dimension

X

Process actions

List processes in model

X

Retrieve metadata for a process

X

Check dump file for failures (chunk count)

X

Read large volume list item data

Preview large data list read

X

Initiate large read request

X

Retrieve status of large read request

X

Download pages

X

Delete read request

X

Initiate large read request on list

X

Retrieve status of large read request on list

X

Download pages

X

Delete read request

X

Read large volume view data

Initiate large read request

X

Retrieve status of large read request

X

Download pages

X

Delete or cancel read request

X

Retrieve logs

Retrieve optimizer action log

X

Revision

Create a revision

X

Retrieve latest revision

X

Retrieve revisions in a model

X

Summary report

Create summary report generation task

X

Retrieve summary report

X

Retrieve summary report generation task

X

Update module cell data

Cell write

X

Upload files for actions

Get model file information

X

Set chunk count for file upload

X

Upload file as a single chunk

X

Upload file in chunks

X

Complete file upload

X

Start the process

X

Monitor the process task

X

Users

Retrieve your user

X

Retrieve user information

X

Retrieve user list

X

Workspaces

List user workspaces

X

Retrieve workspace information

X

API type: CloudWorks

Resource

API endpoint

Export

Import

CloudWorks connections

Get connections

X

Create a connection

X

Delete a connection

X

Patch a connection

X

Edit a connection

X

CloudWorks error logs

Get an import error log

X

Get a process error log

X

CloudWorks history

Get history of integration runs

X

Get integration run errors

X

Get run status

X

CloudWorks integration flows

Create a new integration flow

X

Run an integration flow

X

Get all integration flows

X

Get integration flow by ID

X

Edit an integration flow

X

Delete an integration flow

X

CloudWorks integrations

Create a new integration

X

Create a process integration

X

Get all integrations

X

Get integrations by integration ID

X

Get integrations by model ID

X

Run an integration

X

Cancel running integration

X

Edit a process integration

X

CloudWorks notification configurations

Get a notification configuration

X

Create a notification configuration

X

Edit a notification configuration

X

Delete a notification configuration

X

CloudWorks processes

Get CloudWorks processes

X

Get CloudWorks process details

X

CloudWorks schedules

Create an integration schedule

X

Update the schedule of an integration

X

Delete an integration schedule

X

API type: SCIM

Resource

API endpoint

Export

Import

Resources

Get resource types

X

Get resource schema

X

Service provider configuration

Get supported SCIM capabilities

X

User

Get multiple users

X

Get single user and workspace details

X

Add a user and their workspaces

X

Replace user

X

Edit user details

X

API type: Audit

Resource

API endpoint

Export

Audit events

Get audit events

X

Search audit events

X

API type: Financial Consolidation

Resource

API endpoint

Export

Import

Metadata

Retrieve dimensions and properties in a tenant

X

Retrieve dimensions and properties in a model

X

Retrieve dimension members and their properties

X

OData

Get OData client table

X

Add record to client schema table

X

Add batch records to client schema table

X

Update client schema table records

X

Delete data from client schema table

X

User management

Get user information

X

Add users

X

Delete user account from a tenant

X

Update user profile

X

List roles for a user

X

Unassign user roles

X

Assign user roles

X

Workflow

Start workflow process

X

Stop workflow process

X

Get workflow process state

X

API type: Exception users

Resource

API endpoint

Export

Import

Exception users

List all exception users per workspace

X

List workspaces with exception users

X

Assign or unassign users as exception users in workspace

X