Anaplan
Anaplan is a connected planning platform for models, data integration, application lifecycle management, audit events, and user administration.
Tools (113)
Cancel Action Task
Cancel an action task in an Anaplan model.
Inputs: task_id, model_id, action_id, workspace_id
Cancel Export Task
Cancel an ongoing Anaplan export task.
Inputs: task_id, model_id, export_id, workspace_id
Cancel Import Task
Cancel an ongoing Anaplan import task.
Inputs: task_id, model_id, import_id, workspace_id
Cancel Large List Read
Cancel and delete an Anaplan large-list read request.
Inputs: list_id, model_id, request_id, workspace_id
Cancel Large View Read
Cancel an asynchronous large-view read request.
Inputs: view_id, model_id, request_id, workspace_id
Cancel Process Task
Cancel an ongoing Anaplan process task.
Inputs: task_id, model_id, process_id, workspace_id
Change Model List Items
Add items to an Anaplan model list or irreversibly delete up to 100,000 items by ID or code.
Inputs: items, action, list_id, model_id, workspace_id
Close Model
Close an Anaplan model and return an empty success result.
Inputs: model_id, workspace_id
Complete File Upload
Mark an Anaplan chunked model-file upload as complete.
Inputs: name, file_id, model_id, header_row, chunk_count, workspace_id, first_data_row
Create Model Revision
Create an ALM revision for an Anaplan model.
Inputs: name, model_id, description
Create SCIM User
Create an Anaplan SCIM user and assign up to 50 workspace entitlements.
Inputs: name, active, user_name, external_id, display_name, entitlements
Delete Model File
Delete a file from an Anaplan workspace model.
Inputs: file_id, model_id, workspace_id
Delete Models
Permanently delete multiple models from an Anaplan workspace.
Inputs: model_ids, workspace_id
Download Complete Import Dump
List every chunk of an Anaplan import failure dump, download them sequentially, and return one bounded CSV file.
Inputs: task_id, filename, model_id, import_id, max_chunks, workspace_id, max_total_bytes
Download Complete Large View
Read Anaplan's availablePages count, download every zero-based large-view page in order, and return one bounded CSV file.
Inputs: view_id, filename, model_id, max_pages, request_id, workspace_id, max_total_bytes
Download Complete Model File
List every documented chunk of an Anaplan model file, download them in numeric order, and return one bounded file.
Inputs: file_id, filename, model_id, max_chunks, workspace_id, max_total_bytes
Download Complete Process Dump
List every chunk of an Anaplan process failure dump, download them sequentially, and return one bounded CSV file.
Inputs: task_id, filename, model_id, object_id, max_chunks, process_id, workspace_id, max_total_bytes
Download File Chunk
Download one binary or CSV chunk from an Anaplan model file.
Inputs: file_id, chunk_id, model_id, workspace_id
Download Import Dump Chunk
Download one chunk of an import failure dump using the connected user's Anaplan permissions.
Inputs: task_id, chunk_id, model_id, import_id, workspace_id
Download Large List Page
Download one available CSV page from a completed large-list read.
Inputs: list_id, page_no, model_id, request_id, workspace_id
Download Large List Preview
Download a CSV preview of a large Anaplan list.
Inputs: list_id, model_id, workspace_id
Download Large View Page
Download one available CSV page from a completed large-view read.
Inputs: page_no, view_id, model_id, request_id, workspace_id
Download Optimizer Log
Download the plain-text solution log for an Anaplan Optimizer action task.
Inputs: model_id, action_id, workspace_id, correlation_id
Download Process Dump Chunk
Download one CSV or binary chunk of an Anaplan process failure dump.
Inputs: task_id, chunk_id, model_id, object_id, process_id, workspace_id
Get Action Task
Monitor an Anaplan action task and return its state, progress, result, and failure details when available.
Inputs: task_id, model_id, action_id, workspace_id
Get ALM Comparison Report
Retrieve the structural comparison report between source and target model revisions.
Inputs: target_model_id, source_revision_id, target_revision_id
Get ALM Comparison Report Task
Retrieve state, progress, result, and error details for an ALM comparison report task.
Inputs: task_id, target_model_id
Get ALM Summary Report
Retrieve the structural summary report between source and target model revisions.
Inputs: target_model_id, source_revision_id, target_revision_id
Get ALM Summary Report Task
Retrieve state, progress, result, and error details for an ALM summary report task.
Inputs: task_id, target_model_id
Get Current User
Retrieve the Anaplan user represented by the connected account.
Get Export
Get the metadata for an Anaplan export definition.
Inputs: model_id, export_id, workspace_id
Get Export Task
Monitor an Anaplan export task and return its state, progress, and result.
Inputs: task_id, model_id, export_id, workspace_id
Get Import
Get the metadata for an Anaplan import definition.
Inputs: model_id, import_id, workspace_id
Get Import Failure Dump
Check an import task's dump file for failures using the connected user's Anaplan permissions.
Inputs: task_id, model_id, import_id, workspace_id
Get Import Task
Monitor an Anaplan import task and return its state, progress, result, and failure details when available.
Inputs: task_id, model_id, import_id, workspace_id
Get Large List Read
Retrieve the status and available pages of an Anaplan large-list read request.
Inputs: list_id, model_id, request_id, workspace_id
Get Large View Read
Retrieve the status and available pages of a large-view read request.
Inputs: view_id, model_id, request_id, workspace_id
Get Latest Model Revision
Retrieve the latest ALM revision for an Anaplan model.
Inputs: model_id
Get Model
Get metadata for one Anaplan model.
Inputs: model_id, model_details
Get Model Action
Retrieve metadata for a specific action definition in an Anaplan model.
Inputs: model_id, action_id, workspace_id
Get Model Current Period
Retrieve the current period for an Anaplan model.
Inputs: model_id, workspace_id
Get Model Fiscal Year
Get the current fiscal year from an Anaplan model calendar.
Inputs: model_id, workspace_id
Get Model List
Retrieve metadata for one list in an Anaplan model.
Inputs: list_id, model_id, workspace_id
Get Model Status
Check an Anaplan model's open or opening status and progress.
Inputs: model_id, workspace_id
Get Model Sync Task
Retrieve state, progress, result, and error details for an ALM model synchronization task.
Inputs: task_id, target_model_id
Get Process
Retrieve metadata for one Anaplan process.
Inputs: model_id, process_id, show_import_data_source
Get Process Task
Monitor one asynchronous Anaplan process task.
Inputs: task_id, model_id, process_id, workspace_id, include_process_details
Get SCIM Capabilities
Retrieve Anaplan's SCIM service-provider capabilities.
Get SCIM User
Retrieve one Anaplan SCIM user and their workspace details.
Inputs: user_id
Get User
Retrieve a non-SCIM Anaplan user's ID, active state, email preferences, name, and last login date.
Inputs: user_id
Get View
Retrieve metadata for the dimensions and axes of an Anaplan view.
Inputs: view_id, model_id
Get View Data
Retrieve view cell data as structured JSON or a downloadable raw file.
Inputs: pages, format, view_id, max_rows, model_id, module_id, export_type, response_format
Get Workspace
Retrieve metadata for one Anaplan workspace.
Inputs: workspace_id, tenant_details
List Action Tasks
List execution tasks for an action in an Anaplan model.
Inputs: model_id, action_id, workspace_id
List Audit Events
Retrieve one page of Anaplan audit events of a specified type.
Inputs: type, limit, cursor, offset, interval_in_hours
List Dimension Items
Retrieve all items in an Anaplan model dimension.
Inputs: model_id, dimension_id, workspace_id
List Exports
List the available export definitions for an Anaplan model.
Inputs: model_id, workspace_id
List Export Tasks
List the asynchronous tasks for an Anaplan export definition.
Inputs: model_id, export_id, workspace_id
List File Chunks
List the chunks associated with an Anaplan model file.
Inputs: file_id, model_id, workspace_id
List Import Dump Chunks
Query the chunks available in an import failure dump using the connected user's Anaplan permissions.
Inputs: task_id, model_id, import_id, workspace_id
List Imports
List the import definitions available for an Anaplan model.
Inputs: model_id, workspace_id
List Import Tasks
List the asynchronous tasks for an Anaplan import definition.
Inputs: model_id, import_id, workspace_id
List Line Item Dimension Items
Retrieve items for one dimension of a model line item.
Inputs: model_id, dimension_id, line_item_id
List Line Item Dimensions
Retrieve dimension IDs for a model line item.
Inputs: model_id, line_item_id
List Model Actions
List the action definitions available in an Anaplan model.
Inputs: model_id, workspace_id
List Model Files
List the files available in an Anaplan model.
Inputs: model_id
List Model Line Items
Retrieve line items in a model, optionally including full metadata.
Inputs: model_id, include_all
List Model List Items
Retrieve the items in an Anaplan model list, optionally including full metadata.
Inputs: list_id, model_id, include_all, workspace_id
List Model Lists
Retrieve the lists available in an Anaplan model.
Inputs: model_id, workspace_id
List Model Modules
List the IDs and names of modules in an Anaplan model.
Inputs: model_id
List Models
List models available to the connected Anaplan user.
Inputs: limit, offset, model_details
List Model Sync Tasks
Retrieve ALM synchronization tasks for a target Anaplan model.
Inputs: target_model_id
List Model Versions
Retrieve version metadata for an Anaplan model.
Inputs: model_id
List Model Views
Retrieve the IDs and names of all views in an Anaplan model.
Inputs: model_id, workspace_id, include_subsidiary_views
List Module Line Items
Retrieve line items in a module, optionally including full metadata.
Inputs: model_id, module_id, include_all
List Module Views
Retrieve the IDs and names of views in an Anaplan module.
Inputs: model_id, module_id, include_subsidiary_views
List Process Dump Chunks
List chunks available for an Anaplan process failure dump file.
Inputs: task_id, model_id, object_id, process_id, workspace_id
List Processes
List process definitions available in an Anaplan model.
Inputs: model_id, workspace_id
List Process Tasks
List asynchronous tasks for an Anaplan process.
Inputs: model_id, process_id, workspace_id
List SCIM Resource Types
Retrieve the SCIM resource types supported by Anaplan.
List SCIM Schemas
Retrieve the SCIM resource schemas and attributes supported by Anaplan.
List SCIM Users
Return one page of Anaplan SCIM users, with an optional continuation cursor.
Inputs: count, cursor, filter, start_index
List Syncable Revisions
Retrieve source-model revisions compatible with a target Anaplan model.
Inputs: source_model_id, target_model_id
List Users
List Anaplan users available to the connected account.
Inputs: sort
List View Dimension Items
Retrieve the selected items in a dimension of an Anaplan view.
Inputs: view_id, model_id, dimension_id
List Workspace Model Files
List import and export files for an Anaplan workspace model.
Inputs: model_id, workspace_id
List Workspace Models
Retrieve model IDs and optional model details from an Anaplan workspace.
Inputs: workspace_id, model_details
List Workspaces
List the workspaces available to the connected Anaplan user.
Inputs: tenant_details
Lookup Dimension Items
Look up Anaplan dimension items by name or code.
Inputs: codes, names, model_id, dimension_id, workspace_id
Open Model
Wake an Anaplan model; HTTP 200 means open and 202 means opening.
Inputs: model_id, workspace_id
Patch SCIM User
Apply ordered SCIM add, replace, or remove operations to an Anaplan user.
Inputs: user_id, operations
Replace SCIM User
Replace an Anaplan SCIM user's details and complete workspace entitlement set; an explicitly empty entitlement list irreversibly removes all current workspace access.
Inputs: name, active, user_id, user_name, external_id, display_name, entitlements
Reset Numbered List Index
Irreversibly reset the index of an Anaplan numbered list.
Inputs: list_id, model_id
Search Audit Events
Search Anaplan audit events by lookback interval or explicit time range.
Inputs: type, to_time, interval, from_time
Set File Chunk Count
Set the expected chunk count for an Anaplan model file upload.
Inputs: name, file_id, model_id, header_row, chunk_count, workspace_id, first_data_row
Start Action Task
Start an Anaplan action task that may irreversibly change model data, depending on the action definition.
Inputs: model_id, action_id, locale_name, workspace_id
Start ALM Comparison Report Task
Start generation of an ALM comparison report for source and target revisions.
Inputs: source_model_id, target_model_id, source_revision_id, target_revision_id
Start ALM Summary Report Task
Start generation of an ALM summary report for source and target revisions.
Inputs: source_model_id, target_model_id, source_revision_id, target_revision_id
Start Export Task
Start an Anaplan export and return the asynchronous task acknowledgement.
Inputs: model_id, export_id, locale_name, workspace_id
Start Import Task
Start an Anaplan import that can irreversibly change model data and return the asynchronous task acknowledgement.
Inputs: model_id, import_id, locale_name, workspace_id, mapping_parameters
Start Large List Read
Initiate an Anaplan large-list read request using a caller-supplied request ID.
Inputs: list_id, model_id, request_id, workspace_id
Start Large View Read
Start an asynchronous large-view read request.
Inputs: view_id, model_id, export_type, workspace_id
Start Model Sync Task
Start an ALM synchronization that irreversibly overwrites the target model with the selected source revision.
Inputs: source_model_id, target_model_id, source_revision_id, target_revision_id
Start Process Task
Start an Anaplan process that may irreversibly change model data and return its asynchronous task envelope.
Inputs: model_id, process_id, locale_name, workspace_id, mapping_parameters
Update Model Current Period
Set the current period for an Anaplan model.
Inputs: date, model_id, workspace_id
Update Model Fiscal Year
Update the current fiscal year for an Anaplan model.
Inputs: year, model_id, workspace_id
Update Model List Items
Update existing items in an Anaplan model list.
Inputs: items, list_id, model_id, workspace_id
Update Model Online Status
Change whether an Anaplan model is online.
Inputs: status, model_id
Update Module Cells
Write up to 100,000 cell values or 15 MB by coordinate to an Anaplan module.
Inputs: cells, model_id, module_id
Update Version Switchover
Set a version switchover date and return the model metadata envelope.
Inputs: date, model_id, version_id
Upload Chunked Model File
Set open-ended chunk state, upload a complete model file of at most 100 MB in ordered chunks of at most 50 MB, then mark it complete; use the endpoint chunk tools for larger files.
Inputs: file, file_id, model_id, header_row, workspace_id, first_data_row
Upload File Chunk
Upload one raw binary chunk for an Anaplan model file.
Inputs: file, file_id, chunk_id, model_id, content_type, workspace_id
Upload Model File
Upload an Anaplan model file as one raw binary chunk.
Inputs: file, file_id, model_id, workspace_id