---
canonical_url: "https://docs.composio.dev/toolkits/anaplan"
markdown_url: "https://docs.composio.dev/toolkits/anaplan.md"
product: "platform"
version: null
last_updated: null
---

# Anaplan

Anaplan is a connected planning platform for models, data integration, application lifecycle management, audit events, and user administration.

- **Category:** business intelligence
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 113
- **Triggers:** 0
- **Slug:** `ANAPLAN`
- **Version:** 00000000_00

## Tools

### Cancel Action Task

**Slug:** `ANAPLAN_CANCEL_ACTION_TASK`

Cancel an action task in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | integer | Yes | Model action ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Export Task

**Slug:** `ANAPLAN_CANCEL_EXPORT_TASK`

Cancel an ongoing Anaplan export task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous export task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the export. |
| `export_id` | integer | Yes | Export definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Import Task

**Slug:** `ANAPLAN_CANCEL_IMPORT_TASK`

Cancel an ongoing Anaplan import task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous import task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Large List Read

**Slug:** `ANAPLAN_CANCEL_LARGE_LIST_READ`

Cancel and delete an Anaplan large-list read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Large View Read

**Slug:** `ANAPLAN_CANCEL_LARGE_VIEW_READ`

Cancel an asynchronous large-view read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Process Task

**Slug:** `ANAPLAN_CANCEL_PROCESS_TASK`

Cancel an ongoing Anaplan process task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous process task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Change Model List Items

**Slug:** `ANAPLAN_CHANGE_MODEL_LIST_ITEMS`

Add items to an Anaplan model list or irreversibly delete up to 100,000 items by ID or code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | Items to add or irreversibly delete. Use add fields for additions; for deletion identify each item by ID or code. |
| `action` | string ("add" | "delete") | Yes | Whether to add or delete the supplied list items. |
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Close Model

**Slug:** `ANAPLAN_CLOSE_MODEL`

Close an Anaplan model and return an empty success result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID to close. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Complete File Upload

**Slug:** `ANAPLAN_COMPLETE_FILE_UPLOAD`

Mark an Anaplan chunked model-file upload as complete.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | File name. |
| `file_id` | integer | Yes | Anaplan file ID to mark complete. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `header_row` | integer | No | One-based header row. |
| `chunk_count` | integer | No | Number of uploaded chunks. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |
| `first_data_row` | integer | No | One-based first data row. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Model Revision

**Slug:** `ANAPLAN_CREATE_MODEL_REVISION`

Create an ALM revision for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name for the new revision. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `description` | string | No | Optional revision description. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SCIM User

**Slug:** `ANAPLAN_CREATE_SCIM_USER`

Create an Anaplan SCIM user and assign up to 50 workspace entitlements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | object | Yes | Structured user name. |
| `active` | boolean | No | Whether the user is active. |
| `user_name` | string | Yes | Email address used to sign in to Anaplan. |
| `external_id` | string | No | External identity-system ID for the user. |
| `display_name` | string | No | User display name. |
| `entitlements` | array | No | Up to 50 workspace entitlements to assign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Model File

**Slug:** `ANAPLAN_DELETE_MODEL_FILE`

Delete a file from an Anaplan workspace model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Anaplan file ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Models

**Slug:** `ANAPLAN_DELETE_MODELS`

Permanently delete multiple models from an Anaplan workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_ids` | array | Yes | Model IDs to permanently delete from the workspace. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the models. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Complete Import Dump

**Slug:** `ANAPLAN_DOWNLOAD_COMPLETE_IMPORT_DUMP`

List every chunk of an Anaplan import failure dump, download them sequentially, and return one bounded CSV file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Import task ID whose available failure dump is downloaded. |
| `filename` | string | No | Filename for the assembled CSV dump; path separators are not allowed. |
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `max_chunks` | integer | No | Fail if Anaplan enumerates more than this many chunks, up to 1,000. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `max_total_bytes` | integer | No | Fail if the assembled dump exceeds this many bytes, up to 100 MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Complete Large View

**Slug:** `ANAPLAN_DOWNLOAD_COMPLETE_LARGE_VIEW`

Read Anaplan's availablePages count, download every zero-based large-view page in order, and return one bounded CSV file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `filename` | string | No | Filename for the assembled CSV result; path separators are not allowed. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `max_pages` | integer | No | Fail if the status reports more than this many available pages, up to 1,000. |
| `request_id` | string | Yes | Large-view read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `max_total_bytes` | integer | No | Fail if the assembled result exceeds this many bytes, up to 100 MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Complete Model File

**Slug:** `ANAPLAN_DOWNLOAD_COMPLETE_MODEL_FILE`

List every documented chunk of an Anaplan model file, download them in numeric order, and return one bounded file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Anaplan file ID to download. |
| `filename` | string | No | Filename for the assembled download; path separators are not allowed. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `max_chunks` | integer | No | Fail if Anaplan enumerates more than this many chunks, up to 1,000. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `max_total_bytes` | integer | No | Fail if the assembled download exceeds this many bytes, up to 100 MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Complete Process Dump

**Slug:** `ANAPLAN_DOWNLOAD_COMPLETE_PROCESS_DUMP`

List every chunk of an Anaplan process failure dump, download them sequentially, and return one bounded CSV file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Process task ID. |
| `filename` | string | No | Filename for the assembled CSV dump; path separators are not allowed. |
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `object_id` | integer | Yes | Dump object ID returned by the process task status. |
| `max_chunks` | integer | No | Fail if Anaplan enumerates more than this many chunks, up to 1,000. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `max_total_bytes` | integer | No | Fail if the assembled dump exceeds this many bytes, up to 100 MB. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download File Chunk

**Slug:** `ANAPLAN_DOWNLOAD_FILE_CHUNK`

Download one binary or CSV chunk from an Anaplan model file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Anaplan file ID. |
| `chunk_id` | string | Yes | Chunk ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Import Dump Chunk

**Slug:** `ANAPLAN_DOWNLOAD_IMPORT_DUMP_CHUNK`

Download one chunk of an import failure dump using the connected user's Anaplan permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `chunk_id` | integer | Yes | Zero-based chunk number. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Large List Page

**Slug:** `ANAPLAN_DOWNLOAD_LARGE_LIST_PAGE`

Download one available CSV page from a completed large-list read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | List ID. |
| `page_no` | integer | Yes | Zero-based available page number to download. |
| `model_id` | string | Yes | Anaplan model ID containing the list. |
| `request_id` | string | Yes | Large-list read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Large List Preview

**Slug:** `ANAPLAN_DOWNLOAD_LARGE_LIST_PREVIEW`

Download a CSV preview of a large Anaplan list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Large View Page

**Slug:** `ANAPLAN_DOWNLOAD_LARGE_VIEW_PAGE`

Download one available CSV page from a completed large-view read.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_no` | integer | Yes | Zero-based available page number to download. |
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Optimizer Log

**Slug:** `ANAPLAN_DOWNLOAD_OPTIMIZER_LOG`

Download the plain-text solution log for an Anaplan Optimizer action task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | string | Yes | Optimizer action ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |
| `correlation_id` | string | Yes | Correlation ID of the Optimizer task. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Process Dump Chunk

**Slug:** `ANAPLAN_DOWNLOAD_PROCESS_DUMP_CHUNK`

Download one CSV or binary chunk of an Anaplan process failure dump.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `chunk_id` | integer | Yes | Zero-based chunk number. |
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `object_id` | integer | Yes | Process dump object ID. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Action Task

**Slug:** `ANAPLAN_GET_ACTION_TASK`

Monitor an Anaplan action task and return its state, progress, result, and failure details when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | integer | Yes | Action ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ALM Comparison Report

**Slug:** `ANAPLAN_GET_ALM_COMPARISON_REPORT`

Retrieve the structural comparison report between source and target model revisions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |
| `source_revision_id` | string | Yes | Source model revision ID. |
| `target_revision_id` | string | Yes | Target model revision ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ALM Comparison Report Task

**Slug:** `ANAPLAN_GET_ALM_COMPARISON_REPORT_TASK`

Retrieve state, progress, result, and error details for an ALM comparison report task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ALM Summary Report

**Slug:** `ANAPLAN_GET_ALM_SUMMARY_REPORT`

Retrieve the structural summary report between source and target model revisions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |
| `source_revision_id` | string | Yes | Source model revision ID. |
| `target_revision_id` | string | Yes | Target model revision ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ALM Summary Report Task

**Slug:** `ANAPLAN_GET_ALM_SUMMARY_REPORT_TASK`

Retrieve state, progress, result, and error details for an ALM summary report task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `ANAPLAN_GET_CURRENT_USER`

Retrieve the Anaplan user represented by the connected account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export

**Slug:** `ANAPLAN_GET_EXPORT`

Get the metadata for an Anaplan export definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `export_id` | integer | Yes | Export definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Export Task

**Slug:** `ANAPLAN_GET_EXPORT_TASK`

Monitor an Anaplan export task and return its state, progress, and result.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `export_id` | integer | Yes | Export definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import

**Slug:** `ANAPLAN_GET_IMPORT`

Get the metadata for an Anaplan import definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Failure Dump

**Slug:** `ANAPLAN_GET_IMPORT_FAILURE_DUMP`

Check an import task's dump file for failures using the connected user's Anaplan permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Import Task

**Slug:** `ANAPLAN_GET_IMPORT_TASK`

Monitor an Anaplan import task and return its state, progress, result, and failure details when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Large List Read

**Slug:** `ANAPLAN_GET_LARGE_LIST_READ`

Retrieve the status and available pages of an Anaplan large-list read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Large View Read

**Slug:** `ANAPLAN_GET_LARGE_VIEW_READ`

Retrieve the status and available pages of a large-view read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Latest Model Revision

**Slug:** `ANAPLAN_GET_LATEST_MODEL_REVISION`

Retrieve the latest ALM revision for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model

**Slug:** `ANAPLAN_GET_MODEL`

Get metadata for one Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `model_details` | boolean | No | Include detailed model metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Action

**Slug:** `ANAPLAN_GET_MODEL_ACTION`

Retrieve metadata for a specific action definition in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | string | Yes | Model action ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Current Period

**Slug:** `ANAPLAN_GET_MODEL_CURRENT_PERIOD`

Retrieve the current period for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Fiscal Year

**Slug:** `ANAPLAN_GET_MODEL_FISCAL_YEAR`

Get the current fiscal year from an Anaplan model calendar.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model List

**Slug:** `ANAPLAN_GET_MODEL_LIST`

Retrieve metadata for one list in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Status

**Slug:** `ANAPLAN_GET_MODEL_STATUS`

Check an Anaplan model's open or opening status and progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID whose status should be checked. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Model Sync Task

**Slug:** `ANAPLAN_GET_MODEL_SYNC_TASK`

Retrieve state, progress, result, and error details for an ALM model synchronization task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Process

**Slug:** `ANAPLAN_GET_PROCESS`

Retrieve metadata for one Anaplan process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `process_id` | integer | Yes | Process ID. |
| `show_import_data_source` | boolean | No | Include import data-source details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Process Task

**Slug:** `ANAPLAN_GET_PROCESS_TASK`

Monitor one asynchronous Anaplan process task.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `include_process_details` | boolean | No | Include startTime and duration for each process step. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SCIM Capabilities

**Slug:** `ANAPLAN_GET_SCIM_CAPABILITIES`

Retrieve Anaplan's SCIM service-provider capabilities.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SCIM User

**Slug:** `ANAPLAN_GET_SCIM_USER`

Retrieve one Anaplan SCIM user and their workspace details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Anaplan user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `ANAPLAN_GET_USER`

Retrieve a non-SCIM Anaplan user's ID, active state, email preferences, name, and last login date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Anaplan user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View

**Slug:** `ANAPLAN_GET_VIEW`

Retrieve metadata for the dimensions and axes of an Anaplan view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get View Data

**Slug:** `ANAPLAN_GET_VIEW_DATA`

Retrieve view cell data as structured JSON or a downloadable raw file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pages` | array | No | Page selectors in dimensionId:itemId form; multiple selectors may be supplied. |
| `format` | string | No | JSON response format. Set to v1 with application/json. |
| `view_id` | integer | Yes | View ID. |
| `max_rows` | integer | No | Maximum exported data rows, excluding the header. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `module_id` | integer | No | Parent module ID. Supply it together with export_type. |
| `export_type` | string ("GRID_CURRENT_PAGE" | "GRID_ALL_PAGES" | "TABULAR_SINGLE_COLUMN" | "TABULAR_MULTI_COLUMN") | No | Documented CSV export layout. |
| `response_format` | string ("application/json" | "text/csv" | "text/csv;escaped=true") | Yes | Documented response media type. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `ANAPLAN_GET_WORKSPACE`

Retrieve metadata for one Anaplan workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Anaplan workspace ID. |
| `tenant_details` | boolean | No | Include tenant details with workspace data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Action Tasks

**Slug:** `ANAPLAN_LIST_ACTION_TASKS`

List execution tasks for an action in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | integer | Yes | Model action ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audit Events

**Slug:** `ANAPLAN_LIST_AUDIT_EVENTS`

Retrieve one page of Anaplan audit events of a specified type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Audit event type to retrieve. |
| `limit` | integer | No | Maximum events to return in this page. |
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `offset` | integer | No | Zero-based event offset for the first page. |
| `interval_in_hours` | integer | No | Lookback interval in hours. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Dimension Items

**Slug:** `ANAPLAN_LIST_DIMENSION_ITEMS`

Retrieve all items in an Anaplan model dimension.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the dimension. |
| `dimension_id` | integer | Yes | Dimension ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Exports

**Slug:** `ANAPLAN_LIST_EXPORTS`

List the available export definitions for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Export Tasks

**Slug:** `ANAPLAN_LIST_EXPORT_TASKS`

List the asynchronous tasks for an Anaplan export definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the export. |
| `export_id` | integer | Yes | Export definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List File Chunks

**Slug:** `ANAPLAN_LIST_FILE_CHUNKS`

List the chunks associated with an Anaplan model file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_id` | integer | Yes | Anaplan file ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Import Dump Chunks

**Slug:** `ANAPLAN_LIST_IMPORT_DUMP_CHUNKS`

Query the chunks available in an import failure dump using the connected user's Anaplan permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Imports

**Slug:** `ANAPLAN_LIST_IMPORTS`

List the import definitions available for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the imports. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Import Tasks

**Slug:** `ANAPLAN_LIST_IMPORT_TASKS`

List the asynchronous tasks for an Anaplan import definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Line Item Dimension Items

**Slug:** `ANAPLAN_LIST_LINE_ITEM_DIMENSION_ITEMS`

Retrieve items for one dimension of a model line item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `dimension_id` | integer | Yes | Dimension ID. |
| `line_item_id` | integer | Yes | Line item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Line Item Dimensions

**Slug:** `ANAPLAN_LIST_LINE_ITEM_DIMENSIONS`

Retrieve dimension IDs for a model line item.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `line_item_id` | integer | Yes | Line item ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Actions

**Slug:** `ANAPLAN_LIST_MODEL_ACTIONS`

List the action definitions available in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Files

**Slug:** `ANAPLAN_LIST_MODEL_FILES`

List the files available in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the files. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Line Items

**Slug:** `ANAPLAN_LIST_MODEL_LINE_ITEMS`

Retrieve line items in a model, optionally including full metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `include_all` | boolean | No | Include full metadata instead of the reduced representation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model List Items

**Slug:** `ANAPLAN_LIST_MODEL_LIST_ITEMS`

Retrieve the items in an Anaplan model list, optionally including full metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `include_all` | boolean | No | Include full metadata instead of the reduced representation. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Lists

**Slug:** `ANAPLAN_LIST_MODEL_LISTS`

Retrieve the lists available in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Modules

**Slug:** `ANAPLAN_LIST_MODEL_MODULES`

List the IDs and names of modules in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the modules. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Models

**Slug:** `ANAPLAN_LIST_MODELS`

List models available to the connected Anaplan user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of models to return. |
| `offset` | integer | No | Zero-based result offset. |
| `model_details` | boolean | No | Include model memory-usage details. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Sync Tasks

**Slug:** `ANAPLAN_LIST_MODEL_SYNC_TASKS`

Retrieve ALM synchronization tasks for a target Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Versions

**Slug:** `ANAPLAN_LIST_MODEL_VERSIONS`

Retrieve version metadata for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the versions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Model Views

**Slug:** `ANAPLAN_LIST_MODEL_VIEWS`

Retrieve the IDs and names of all views in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the views. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `include_subsidiary_views` | boolean | No | Include unsaved subsidiary views when set to true. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Module Line Items

**Slug:** `ANAPLAN_LIST_MODULE_LINE_ITEMS`

Retrieve line items in a module, optionally including full metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `module_id` | string | Yes | Module ID. |
| `include_all` | boolean | No | Include full metadata instead of the reduced representation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Module Views

**Slug:** `ANAPLAN_LIST_MODULE_VIEWS`

Retrieve the IDs and names of views in an Anaplan module.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the module. |
| `module_id` | string | Yes | Module ID. |
| `include_subsidiary_views` | boolean | No | Include subsidiary views in the result. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Process Dump Chunks

**Slug:** `ANAPLAN_LIST_PROCESS_DUMP_CHUNKS`

List chunks available for an Anaplan process failure dump file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Asynchronous task ID. |
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `object_id` | integer | Yes | Process dump object ID. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Processes

**Slug:** `ANAPLAN_LIST_PROCESSES`

List process definitions available in an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the processes. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Process Tasks

**Slug:** `ANAPLAN_LIST_PROCESS_TASKS`

List asynchronous tasks for an Anaplan process.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `process_id` | integer | Yes | Process ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SCIM Resource Types

**Slug:** `ANAPLAN_LIST_SCIM_RESOURCE_TYPES`

Retrieve the SCIM resource types supported by Anaplan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SCIM Schemas

**Slug:** `ANAPLAN_LIST_SCIM_SCHEMAS`

Retrieve the SCIM resource schemas and attributes supported by Anaplan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SCIM Users

**Slug:** `ANAPLAN_LIST_SCIM_USERS`

Return one page of Anaplan SCIM users, with an optional continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `count` | integer | No | Number of SCIM users to return, from 1 to 100. |
| `cursor` | string | No | Continuation cursor from a previous response; omit for the first page. |
| `filter` | string | No | SCIM filter expression. |
| `start_index` | integer | No | One-based SCIM result index at which to start. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Syncable Revisions

**Slug:** `ANAPLAN_LIST_SYNCABLE_REVISIONS`

Retrieve source-model revisions compatible with a target Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_model_id` | string | Yes | Source model ID whose compatible revisions should be returned. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `ANAPLAN_LIST_USERS`

List Anaplan users available to the connected account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | User sort expression, such as +emailAddress. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List View Dimension Items

**Slug:** `ANAPLAN_LIST_VIEW_DIMENSION_ITEMS`

Retrieve the selected items in a dimension of an Anaplan view.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `dimension_id` | integer | Yes | Dimension ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Model Files

**Slug:** `ANAPLAN_LIST_WORKSPACE_MODEL_FILES`

List import and export files for an Anaplan workspace model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the files. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspace Models

**Slug:** `ANAPLAN_LIST_WORKSPACE_MODELS`

Retrieve model IDs and optional model details from an Anaplan workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Anaplan workspace ID containing the models. |
| `model_details` | boolean | No | Include detailed model metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `ANAPLAN_LIST_WORKSPACES`

List the workspaces available to the connected Anaplan user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tenant_details` | boolean | No | Include tenant details with workspace data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Lookup Dimension Items

**Slug:** `ANAPLAN_LOOKUP_DIMENSION_ITEMS`

Look up Anaplan dimension items by name or code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `codes` | array | No | Dimension item codes to look up. |
| `names` | array | No | Dimension item names to look up. |
| `model_id` | string | Yes | Anaplan model ID containing the dimension. |
| `dimension_id` | integer | Yes | Dimension ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Open Model

**Slug:** `ANAPLAN_OPEN_MODEL`

Wake an Anaplan model; HTTP 200 means open and 202 means opening.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID to open. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Patch SCIM User

**Slug:** `ANAPLAN_PATCH_SCIM_USER`

Apply ordered SCIM add, replace, or remove operations to an Anaplan user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Anaplan SCIM user ID to patch. |
| `operations` | array | Yes | Ordered SCIM patch operations to apply. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace SCIM User

**Slug:** `ANAPLAN_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | object | Yes | Structured user name. |
| `active` | boolean | No | Whether the user is active. |
| `user_id` | string | Yes | Anaplan SCIM user ID to replace. |
| `user_name` | string | Yes | Email address used to sign in to Anaplan. |
| `external_id` | string | No | External identity-system ID for the user. |
| `display_name` | string | No | User display name. |
| `entitlements` | array | Yes | Required complete replacement set of up to 50 workspace entitlements. An empty list removes all workspace access. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Numbered List Index

**Slug:** `ANAPLAN_RESET_NUMBERED_LIST_INDEX`

Irreversibly reset the index of an Anaplan numbered list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | string | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Audit Events

**Slug:** `ANAPLAN_SEARCH_AUDIT_EVENTS`

Search Anaplan audit events by lookback interval or explicit time range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Audit event type to retrieve. |
| `to_time` | string | No | End of the documented explicit time range. |
| `interval` | integer | No | Lookback interval in hours. |
| `from_time` | string | No | Start of the documented explicit time range. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set File Chunk Count

**Slug:** `ANAPLAN_SET_FILE_CHUNK_COUNT`

Set the expected chunk count for an Anaplan model file upload.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | File name. |
| `file_id` | integer | Yes | Anaplan file ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `header_row` | integer | No | One-based header row. |
| `chunk_count` | integer | Yes | Expected chunk count from 1 to 1,000; use -1 when the final count is not yet known and finalize it later. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |
| `first_data_row` | integer | No | One-based first data row. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Action Task

**Slug:** `ANAPLAN_START_ACTION_TASK`

Start an Anaplan action task that may irreversibly change model data, depending on the action definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `action_id` | integer | Yes | Model action ID. |
| `locale_name` | string | Yes | Locale used for task execution, such as en_US. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start ALM Comparison Report Task

**Slug:** `ANAPLAN_START_ALM_COMPARISON_REPORT_TASK`

Start generation of an ALM comparison report for source and target revisions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_model_id` | string | Yes | Source model ID to compare. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |
| `source_revision_id` | string | Yes | Source revision ID to compare. |
| `target_revision_id` | string | Yes | Target revision ID to compare. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start ALM Summary Report Task

**Slug:** `ANAPLAN_START_ALM_SUMMARY_REPORT_TASK`

Start generation of an ALM summary report for source and target revisions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_model_id` | string | Yes | Source model ID to compare. |
| `target_model_id` | string | Yes | Target Anaplan model ID for the ALM operation. |
| `source_revision_id` | string | Yes | Source revision ID to compare. |
| `target_revision_id` | string | Yes | Target revision ID to compare. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Export Task

**Slug:** `ANAPLAN_START_EXPORT_TASK`

Start an Anaplan export and return the asynchronous task acknowledgement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `export_id` | integer | Yes | Export definition ID. |
| `locale_name` | string | Yes | Locale used for export execution, such as en_US. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Import Task

**Slug:** `ANAPLAN_START_IMPORT_TASK`

Start an Anaplan import that can irreversibly change model data and return the asynchronous task acknowledgement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the import. |
| `import_id` | integer | Yes | Import definition ID. |
| `locale_name` | string | Yes | Locale used for import execution, such as en_US. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |
| `mapping_parameters` | array | No | Optional target dimension items for an import configured with mapping parameters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Large List Read

**Slug:** `ANAPLAN_START_LARGE_LIST_READ`

Initiate an Anaplan large-list read request using a caller-supplied request ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `request_id` | string | Yes | Large-read request ID. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Large View Read

**Slug:** `ANAPLAN_START_LARGE_VIEW_READ`

Start an asynchronous large-view read request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | integer | Yes | View ID. |
| `model_id` | string | Yes | Anaplan model ID containing the view. |
| `export_type` | string ("GRID_ALL_PAGES" | "TABULAR_SINGLE_COLUMN" | "TABULAR_MULTI_COLUMN") | Yes | Large-view export layout. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Model Sync Task

**Slug:** `ANAPLAN_START_MODEL_SYNC_TASK`

Start an ALM synchronization that irreversibly overwrites the target model with the selected source revision.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source_model_id` | string | Yes | Source model ID to synchronize. |
| `target_model_id` | string | Yes | Target Anaplan model ID that synchronization will overwrite. |
| `source_revision_id` | string | Yes | Source revision ID to synchronize. |
| `target_revision_id` | string | Yes | Target revision ID for the synchronization. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Start Process Task

**Slug:** `ANAPLAN_START_PROCESS_TASK`

Start an Anaplan process that may irreversibly change model data and return its asynchronous task envelope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model_id` | string | Yes | Anaplan model ID containing the process. |
| `process_id` | integer | Yes | Process ID. |
| `locale_name` | string | Yes | Locale used for task execution, such as en_US. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `mapping_parameters` | array | No | Optional target dimension items when the process runs an import with mapping parameters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model Current Period

**Slug:** `ANAPLAN_UPDATE_MODEL_CURRENT_PERIOD`

Set the current period for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Current-period date in the provider's documented YYYY-MM-DD form. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model Fiscal Year

**Slug:** `ANAPLAN_UPDATE_MODEL_FISCAL_YEAR`

Update the current fiscal year for an Anaplan model.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | string | Yes | Fiscal-year label to set, such as FY21. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model List Items

**Slug:** `ANAPLAN_UPDATE_MODEL_LIST_ITEMS`

Update existing items in an Anaplan model list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `items` | array | Yes | List items to update, including each item's identifying name and changed code, parent, or properties. |
| `list_id` | integer | Yes | List ID. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Model Online Status

**Slug:** `ANAPLAN_UPDATE_MODEL_ONLINE_STATUS`

Change whether an Anaplan model is online.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status` | string ("online" | "offline") | Yes | Desired model online status. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Module Cells

**Slug:** `ANAPLAN_UPDATE_MODULE_CELLS`

Write up to 100,000 cell values or 15 MB by coordinate to an Anaplan module.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cells` | array | Yes | Cell updates identified by line item and optional dimension coordinates. Maximum 100,000 cells or 15 MB. |
| `model_id` | string | Yes | Anaplan model ID containing the module. |
| `module_id` | string | Yes | Module ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Version Switchover

**Slug:** `ANAPLAN_UPDATE_VERSION_SWITCHOVER`

Set a version switchover date and return the model metadata envelope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Version switchover date in YYYY-MM-DD form, or empty to reset it. |
| `model_id` | string | Yes | Anaplan model ID containing the resource. |
| `version_id` | string | Yes | Model version ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Chunked Model File

**Slug:** `ANAPLAN_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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Complete file to split into chunks no larger than Anaplan's documented 50 MB limit. |
| `file_id` | integer | Yes | Existing Anaplan file ID whose content is replaced. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `header_row` | integer | No | One-based header row in the file. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the model. |
| `first_data_row` | integer | No | One-based first data row in the file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload File Chunk

**Slug:** `ANAPLAN_UPLOAD_FILE_CHUNK`

Upload one raw binary chunk for an Anaplan model file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Chunk file whose bytes are uploaded as the request body. |
| `file_id` | integer | Yes | Anaplan file ID. |
| `chunk_id` | string | Yes | Chunk ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `content_type` | string ("application/octet-stream" | "application/x-gzip") | No | Media type for an uncompressed or gzip-compressed chunk. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Model File

**Slug:** `ANAPLAN_UPLOAD_MODEL_FILE`

Upload an Anaplan model file as one raw binary chunk.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | File whose bytes are uploaded as the request body. |
| `file_id` | integer | Yes | Anaplan file ID. |
| `model_id` | string | Yes | Anaplan model ID containing the file. |
| `workspace_id` | string | Yes | Anaplan workspace ID containing the resource. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |