# Anaplan

> Connect Anaplan to automate models and integration tasks.

App · 19 actions. Web page: https://docs.lodol.com/docs/integrations/anaplan

## Actions

### Get action

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Action (`action_id`, text, required): Action id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get export

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Export (`export_id`, text, required): Export id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get export task

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Export (`export_id`, text, required): Export id for this request.
- Task id (`task_id`, text, required): Task id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get import

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Import (`import_id`, text, required): Import id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get import task

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Import (`import_id`, text, required): Import id for this request.
- Task id (`task_id`, text, required): Task id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get list metadata

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- List (`list_id`, text, required): List id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get process task

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Process (`process_id`, text, required): The saved process to start or inspect.
- Task id (`task_id`, text, required): Task id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List actions

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List exports

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List file chunks

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- File (`file_id`, text, required): File id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List files

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List imports

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List lists

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List models

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List processes

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List workspaces

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

**Inputs**: None.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Start export

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Export (`export_id`, text, required): Export id for this request.
- Locale (`locale`, text, required): Locale for this request. One of: `en_US`, `en_GB`, `de_DE`, `fr_FR`, `es_ES`, `it_IT`, `ja_JP`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Start import

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Import (`import_id`, text, required): Import id for this request.
- Locale (`locale`, text, required): Locale for this request. One of: `en_US`, `en_GB`, `de_DE`, `fr_FR`, `es_ES`, `it_IT`, `ja_JP`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Start process

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

**Inputs**

- Workspace (`workspace_id`, text, required): Workspace id for this request.
- Model (`model_id`, text, required): Model id for this request.
- Process (`process_id`, text, required): The saved process to start or inspect.
- Locale (`locale`, text, required): Locale for this request. One of: `en_US`, `en_GB`, `de_DE`, `fr_FR`, `es_ES`, `it_IT`, `ja_JP`.

**Outputs**

- `data` (object): The service response, including all records and metadata.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```
