Anaplan

https://help.anaplan.com
Admin
Anaplan is a cloud-based connected planning platform that enables organizations to model complex...
Tokens:1,862,729
Snippets:15,353
Trust Score:10
Update:5 days ago
Show doc for...
Tokens:
Raw
### Response 200 for starting process

Source: https://help.anaplan.com/start-the-process-c76c3d8d-9d98-4a76-bd6d-efed03ebecb4

Example JSON response returned when the process starts successfully. Contains the taskId.

```json
{
   "taskId" : "E1F648F527AF4297B09E06C278B99F4C"
 }
```

--------------------------------

### Installation to a specific directory

Source: https://help.anaplan.com/898abd84-d6c7-44d5-94e5-848a9bfeaa13

Install the add-in to a specific directory using /i and APPDIR. The PowerPointAddin Setup wizard displays when executed.

```command line
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanPowerPointAddin.Release.msi" APPDIR="C:/Users/AnaplanUser/Add-in Folder"
```

--------------------------------

### Curl example to start a process action

Source: https://help.anaplan.com/3db20a69-108a-4ecd-8e34-4905513164cd

Use this curl command to start a process action. It posts a task to the specified process ID and returns a task ID for monitoring. The example uses a placeholder token and sets the locale to US English.

```bash
curl -X POST \
 https://api.anaplan.com/2/0/workspaces/0a800b00e0000000f000001eab0d0000/models/F1111111C11111111B11111F1111E11F/processes/118000000002/tasks \
 -H 'authorization: AnaplanAuthToken {token}' \
 -H "Content-Type:application/json" \
 -d '{"localeName": "en_US"}'
```

--------------------------------

### Quiet installation with /q

Source: https://help.anaplan.com/898abd84-d6c7-44d5-94e5-848a9bfeaa13

Use /q to perform a quiet installation with no installation wizard.

```command line
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanPowerPointAddin.Release.msi" /q
```

--------------------------------

### GET /api/v2305.1/process/start/ImportandExports/Data/ModelExport

Source: https://help.anaplan.com/structure-of-an-api-request-bcddc03e-9c46-4174-9bae-347cf77a45d4

Example of a request to start a process workflow for model export.

```APIDOC
## GET /api/v2305.1/process/start/ImportandExports/Data/ModelExport

### Description
Starts a process workflow for model export.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/process/start/ImportandExports/Data/ModelExport

### Parameters
#### Path Parameters
- **ImportandExports** (string) - Required - The import/export category.
- **Data** (string) - Required - The data type.
- **ModelExport** (string) - Required - The model export name.

### Response
#### Success Response (200)
- **status** (string) - The state of the workflow.

#### Response Example
{
  "status": "started"
}
```

--------------------------------

### Curl GET request to OData endpoint

Source: https://help.anaplan.com/480986d3-a907-4675-9cdf-1392e95e1a20

Use this curl command to send a GET request to the OData endpoint. It includes the TENANT and X_API_TOKEN headers. The example filters data for dates starting with '2024'.

```bash
curl -L -X GET 'https://fluenceapi-prod.fluence.app/api/v2305.1/odata/Consolidation?$filter=startswith(Date,’2024’)' \
-H 'TENANT: CustomerTenant' \
-H 'X_API_TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf'
```

--------------------------------

### Response 200 body for get current fiscal year

Source: https://help.anaplan.com/get-current-fiscal-year-0454318c-0d4f-4d35-8d0e-2969a03ec7b3

Example JSON response returned by the endpoint when the request is successful. Shows the fiscal year, start date, and end date.

```json
{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/objects/modelCalendar"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "modelCalendar": {
       "fiscalYear": {
           "year": "FY21",
           "startDate": "2021-01-01",
           "endDate": "2021-12-31"
       }
   }
 }
```

--------------------------------

### mapping.xml - Simple mapping example

Source: https://help.anaplan.com/connection-parameter-web-extension-49f28d5c-fd8d-4ce3-b760-4b9cfcab0569

This configuration maps a web parameter 'connection' with value 'mapped' to use the AlternativeServer. Blank database and cube details are left unchanged. The example URL shows how to load the report with the parameter.

```xml
<parameterMappings> <parameter name="connection"> <mapping value="mapped" server="AlternativeServer" database="" cube="" /> </parameter> </parameterMappings>
```

```url
https://MyServer/AnaplanXLWeb/WebForm/ShowReport.aspx?rep=673dad1d-e406-4493-8ee3-6afdc9ec4f7f.wbsql&connection=mapped
```

--------------------------------

### GET /processes/{taskId}

Source: https://help.anaplan.com/monitor-the-process-tasks-95904c2c-9253-4293-a13c-cf8e44881b17

Gets the status of a specific export task. Optionally include process details to get start time and duration of each step.

```APIDOC
## GET /processes/{taskId}

### Description
Gets the status of a specific export task. Optionally include process details to get start time and duration of each step.

### Method
GET

### Endpoint
/processes/{taskId}

### Parameters
#### Path Parameters
- **taskId** (string) - Required - The ID of the process task to monitor.

#### Query Parameters
- **includeProcessDetails** (boolean) - Optional - When true, includes the start time and duration of each step.

### Response
#### Success Response (200)
- **currentStep** (object) - The task associated with the specified taskId.
- **taskState** (string) - The status of the process task. Possible values: NOT_STARTED, IN_PROGRESS, COMPLETE, CANCELLING, CANCELLED.
- **progress** (double) - Typically 1.0.
- **result** (object) - Indicates whether a failure dump file was created, the objectId, and whether the task succeeded.
- **failureDumpAvailable** (boolean) - Indicates whether this process container or an action within it has a failure dump file. For a deletion action, this is always false.
- **nestedResults** (array) - Indicates whether the actions carried out in the process were successful. Contains details in the form of a JSON array, including debug information when failures occur.
- **objectID** (string) - The identifier of the process task or a task that it includes.
- **taskID** (string) - The ID that you specified in the request.
- **duration** (number) - The overall processing time.
- **startTime** (string) - The time when the step started.

#### Response Example
{
  "currentStep": {},
  "taskState": "COMPLETE",
  "progress": 1.0,
  "result": {},
  "failureDumpAvailable": false,
  "nestedResults": [],
  "objectID": "string",
  "taskID": "string",
  "duration": 0,
  "startTime": "string"
}
```

--------------------------------

### Quiet installation with progress bar using /qr option

Source: https://help.anaplan.com/0b1f0748-2805-4988-a394-bdb6186a94df

Use this command to perform a quiet installation with only a progress bar and no final window. The /qr option also enables installation without administrator permissions.

```command
msiexec /i "C:\Users\AnaplanUser\Downloads\AnaplanExcelAddin.Release.msi" /qr
```

--------------------------------

### Download prerequisites to a folder

Source: https://help.anaplan.com/anaplan-xl-reporting-silent-installation-92c87d07-ae25-49d3-bd4b-2f0709a1ecd1

Use this command to create a folder with all installation files in the correct layout, which can be copied to a DVD or target computer.

```plaintext
AnaplanXLReporting.exe /layout
```
Tokens:
Raw