### 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"}'
```

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

### msiexec /i with APPDIR for custom directory installation

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

Use this command to install the add-in to a specific directory. Replace the path between the quotation marks with your desired directory. When executed, the PowerPointAddin Setup wizard displays.

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

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

### Curl example: GET /users

Source: https://help.anaplan.com/d7b672ee-2777-4adb-a933-3418a9929323

Retrieves a list of users for the CustomerTenant tenant. Requires the TENANT and X-API-TOKEN headers. The API enforces a 60-second timeout on GET commands.

```bash
curl --location 'https://fluenceapi-prod.fluence.app/api/v2305.1/users' \
--header 'TENANT: CustomerTenant' \
--header 'X-API-TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf'
```

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

### 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"
}
```

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

### Response for GET /ResourceTypes

Source: https://help.anaplan.com/get-resource-types-39e7544b-4731-42fb-ae08-e47fb41bf4d0

Example JSON response showing a list of resource types, including the User resource type with its metadata and schema.

```json
{  
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],  
    "totalResults": 1,  
    "startIndex": 1,  
    "itemsPerPage": 50,  
    "Resources": [{  
         "schemas": ["urn:ietf:params:scim:schemas:core:2.0:ResourceType"],  
         "meta": {  
              "resourceType": "ResourceType",  
              "location": "https://api.anaplan.com/scim/1/0/v2/ResourceTypes/User"  
         },  
         "id": "User",  
         "name": "User",  
         "endpoint": "/Users",  
         "description": "User Account",  
         "schema": "urn:ietf:params:scim:schemas:core:2.0:User"  
    }]  
 }
```

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

### Sample JSON response for GET /Users

Source: https://help.anaplan.com/get-multiple-users-08193d51-b8d8-48cc-855d-b20983ee6ef6

Example response from the GET /Users endpoint showing a single user with metadata, name, and entitlements. Note the response includes both a string 'active' field and a boolean 'active' field.

```json
{
   	"totalResults": 1,
   	"startIndex": 1,
   	"itemsPerPage": 1,
   	"Resources": [
   		{
   			"schemas": [
   				"urn:ietf:params:scim:schemas:core:2.0:User"
   			],
   			"meta": {
   				"resourceType": "User",
   				"created": "2018-04-24T23:43:48.000+00:00",
   				"lastModified": "2019-01-15T22:04:19.000+00:00",
   				"location": "https://localhost:8090/1/0/v2/Users/8a80db9362f64cad0162fa0ab3fe0001"
   			},
   			"id": "8a80db9362f64cad0162fa0ab3fe0001",
   			"externalId": "",
   			"active": "True",
   			"userName": "sfqasuper@anaplan.com",
   			"name": {
   				"familyName": "Super",
   				"givenName": "SFQA",
   				"formatted": "SFQA Super"
   			},
   			"displayName": "SFQA Super",
   			"active": true,
   			"entitlements": [
   				{
   					"display": "Finance Workspace",
   					"value": "6edb50156273d29050001",
   					"type": "WORKSPACE"
   				},
   				{
   					"display": "Sales Workspace",
   					"value": "6edb50156273d29050002",
   					"type": "WORKSPACE"
   				},
   				{
   					"value": "6edb50156273d29050001,6edb50156273d29050002",
   					"type": "WORKSPACE_IDS"
   				}
   			]
   		}
   	]
}
```

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

### Curl example for GET /ServiceProviderConfig

Source: https://help.anaplan.com/get-supported-scim-capabilities-24bb9b1f-a47e-49f7-9647-5d90717e4aa2

Use this curl command to retrieve the supported SCIM capabilities. The endpoint is https://api.anaplan.com/scim/1/0/v2/ServiceProviderConfig.

```bash
curl -X GET https://api.anaplan.com/scim/1/0/v2/ServiceProviderConfig
```

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

### Curl example for GET /ResourceTypes

Source: https://help.anaplan.com/get-resource-types-39e7544b-4731-42fb-ae08-e47fb41bf4d0

Use this curl command to retrieve all supported resource types from the Anaplan SCIM API.

```bash
curl -X GET https://api.anaplan.com/scim/1/0/v2/ResourceTypes
```

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

### XL3RefreshConnections example with XL3Link

Source: https://help.anaplan.com/70b2e734-8944-488e-8b56-cb8e54801c8b

Example setup: first create the XL3RefreshConnections formula referencing cell $A$1 and connection 1, then set up an XL3Link to fire the refresh. Selecting the link will refresh all grids/small multiples/etc. connected to connection 1.

```formula
=XL3RefreshConnections($A$1, 1)
```

```formula
=XL3Link(XL3Address($A$1),"Refresh All",,XL3Address($A$1),TRUE)
```

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

### Response: GET /users

Source: https://help.anaplan.com/d7b672ee-2777-4adb-a933-3418a9929323

Example JSON response containing user details such as userId, userName, fullName, isDisabled, email, and roles. The response shows multiple user objects.

```json
[
    {
        "userId": 3,
        "userName": "jdoe@fluence.app",
        "fullName": "Jane Doe",
        "isDisabled": false,
        "email": "jdoe@acme.com",
        "roles": [
            "Admin",
            "Controller",
            "Preparer"
        ]
    },
    {
        "userId": 164,
        "userName": "jbay@fluence.app",
        "fullName": "James Bay",
        "isDisabled": false,
        "email": "jbay@acme.com",
        "roles": [
            "Admin",
            "Controller",
            "Preparer",
            "Reviewer",
            "Cash Team",
            "Reporting Manager",
            "Accounting Manager",
            "Consolidation Workflow"
        ]
    },
    {
        "userId": 208,
        "userName": "ttesfaye@fluence.app",
        "fullName": "Teddy Tesfaye",
        "isDisabled": false,
        "email": "tesfaye@acme.com",
        "roles": [
            "Admin"
        ]
    },
    {
        "userId": 235,
        "userName": "hkovacs@fluence.app",
        "fullName": "Hanna Kovacs",
        "isDisabled": false,
        "email": "kovacs@acme.com",
        "roles": [
            "Admin",
            "Controller"
        ]
    }
]
```

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

### Curl example for GET /users/me

Source: https://help.anaplan.com/d5e7ae19-0a8a-44a7-a482-bdee7479e039

Use this curl command to retrieve the user associated with the Anaplan authentication token. Replace {anaplan_auth_token} with your actual token.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/users/me \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
 -H 'Content-Type:application/json'
```

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

### Response 200 for starting an import task

Source: https://help.anaplan.com/start-the-import-7e0dcedb-3628-44a1-8688-4a68eef85cdb

Example JSON response returned when the import task is successfully created. The taskId can be used to track the import status.

```json
{
  "taskId" : "5E6331685CC648A29B725923B8FAEA1C"
}
```

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

### Curl example for GET /Schemas

Source: https://help.anaplan.com/get-resource-schema-7523d5ad-0743-43fd-b868-89cd8856759b

Use this curl command to retrieve the supported attributes and attribute metadata for resources. The endpoint is https://api.anaplan.com/scim/1/0/v2/Schemas.

```bash
curl -X GET https://api.anaplan.com/scim/1/0/v2/Schemas
```

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

### Response 200 for starting export task

Source: https://help.anaplan.com/start-the-export-03d2acc9-0305-42c3-816e-15629133e9c5

Example JSON response returned when the export task is successfully created. It includes the taskId in the task object.

```json
{
   "meta":{
      "schema":"https://api.anaplan.com//2/0/models/736367E9DB484E3AB3A50C3704FD33ED/objects/task"
   },
   "status":{
      "code":200,
      "message":"Success"
   },
   "task":{
      "taskId":"F362B99442C54425970E200037D48A91"
   }
 }
```

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

### Curl example for GET /user/{username}/roles

Source: https://help.anaplan.com/list-roles-for-a-user-582f9dfa-1f2b-4e67-a98b-120e58a9f5a9

Use this curl command to retrieve the roles for a specific user. Replace the username in the URL with the Financial Consolidation app username (not email). The TENANT and X-API-TOKEN headers are required for authentication. The API enforces a 60-second timeout on GET commands.

```bash
curl --location 'https://fluenceapi-prod.fluence.app/api/v2305.1/user/john.doe@fluence.app/roles' \
--header 'TENANT: CustomerTenant' \
--header 'X-API-TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf'
```

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

### Response for GET /workspaces?tenantDetails=true

Source: https://help.anaplan.com/list-user-workspaces-c324d0af-01ce-4e6b-8039-06289a4f5b19

Example JSON response from the workspace listing endpoint. It includes metadata with paging information, a status of 200 with message 'Success', and a workspaces array containing workspace details such as id, name, active flag, sizeAllowance, and currentSize.

```json
{
   "meta": {
     "schema": "https://api.anaplan.com/2/0/objects/workspace",
     "paging": {
       "currentPageSize": 1,
       "totalSize": 1,
       "offset": 0
     }
   },
   "status": {
     "code": 200,
     "message": "Success"
   },
   "workspaces": [
     {
     "id": "8a8b8c8d8e8f8g8i",
     "name": "Financial Planning",
     "active": true,
     "sizeAllowance": 1073741824,
     "currentSize": 873741824
     }
   ]
 }
```

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

### Response from starting a process action

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

The response from the POST request includes a task object with a taskId, taskState, and creationTime. The example shows a successful response with status code 200 and taskState NOT_STARTED.

```json
{
   "meta":{
      "schema":"https://api.anaplan.com/2/0/models/F1111111C11111111B11111F1111E11F/objects/task"
   },
   "status":{
      "code":200,
      "message":"Success"
   },
   "task":{
      "taskId":"E36791D709C44246878B708B4C76A1F9",
      "taskState":"NOT_STARTED",
      "creationTime":1570823579809
   }
}
```

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

### Curl example for retrieving list items

Source: https://help.anaplan.com/retrieve-list-data-2309ce30-9f81-40d4-a7c3-473a8ff60667

Use this curl command to call the GET endpoint. Replace {workspaceId}, {modelId}, {listId}, and {anaplan_auth_token} with actual values. The includeAll query parameter is set to true.

```bash
curl -X GET 'https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/lists/{listId}/items?includeAll=true' \
 -H 'Accept: application/json' \
 -H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
```

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

### 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
```

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

### 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"
}
```

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

### Curl example for GET /users/{userId}

Source: https://help.anaplan.com/45d7e37a-652c-44f1-8b81-06b9034f707c

Use this curl command to retrieve user information. Requires a Workspace Administrator role or any tenant-level access role. Replace {userId} and {anaplan_auth_token} with actual values.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/users/{userId} \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
 -H 'Content-Type:application/json'
```

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

### 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
```

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

### Curl example: GET line items with includeAll=true

Source: https://help.anaplan.com/retrieve-all-line-item-metadata-in-a-module-c8c41f1d-dd4e-4ca6-ac92-1a3d6c46bfeb

Use this curl command to retrieve all line items and metadata for a module. Replace {modelId}, {moduleId}, and {anaplan_auth_token} with actual values. Requires workspace administrator role and Read access to the module.

```bash
curl -X GET 'https://api.anaplan.com/2/0/models/{modelId}/modules/{moduleId}/lineItems?includeAll=true' \
 -H 'Authorization: AnaplanAuthToken {anaplan_auth_token}' \
 -H 'Accept: application/json'
```

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

### 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
```

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

### Example chunk object

Source: https://help.anaplan.com/upload-a-file-in-chunks-64df7566-f12f-45f0-a2f9-a992688ebc47

Example JSON object returned in the chunks array when getting the chunks in a file. Contains id and name fields.

```json
{
  "id": "0",
  "name": "Chunk 0"
 }
```

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

### Example command to run the conversion script

Source: https://help.anaplan.com/troubleshoot-wrapped-keys-2facc339-7673-43a7-857b-ff88fdd9b439

Example command that runs the script named convertPublicKey.sh with the key file myPublicKey.pem. This generates two PEM files with .pkcs8.pem and .pkcs1.pem suffixes.

```bash
sh convertPublicKey.sh myPublicKey.pem
```

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

### GET /api/v2305.1/users

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

Example of a request to retrieve a list of users in the tenant.

```APIDOC
## GET /api/v2305.1/users

### Description
Retrieves a list of users in the tenant.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/users

### Response
#### Success Response (200)
- **users** (array) - List of users.

#### Response Example
{
  "users": []
}
```

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

### View installation options with msiexec

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

Run the MSI file with msiexec to display the Windows Installer dialog with a full list of installation options. Requires administrator permissions.

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

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

### GET /api/v2305.1/metadata/Dimensions

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

Example of a request to retrieve metadata for all dimensions across a tenant.

```APIDOC
## GET /api/v2305.1/metadata/Dimensions

### Description
Retrieves a list of all dimensions, including parent-child relationships and attributes, across a tenant.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/metadata/Dimensions

### Parameters
#### Path Parameters
- **Dimensions** (string) - Required - The resource path for dimensions.

### Response
#### Success Response (200)
- **dimensions** (array) - List of dimensions with metadata.

#### Response Example
{
  "dimensions": []
}
```

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

### Quiet installation with /q option

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

Use this command to perform a quiet installation of the add-in, with no installation wizard. The /q option suppresses the user interface.

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

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

### InstalledExtensions.xml - Register ConnectionParameterExtension.dll

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

Create this file in the Extensions folder to load the extension. Place it in the same folder as the DLL, typically C:\inetpub\wwwroot\AnaplanXLWeb\Extensions.

```xml
<?xml version="1.0" encoding="utf-8" ?> <installation> <extensions> <extension source="RelativeFile" location="ConnectionParameterExtension.dll" /> </extensions> </installation>.
```

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

### GET /api/v2305.1/odata

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

Example of a request to the OData endpoint to retrieve data records.

```APIDOC
## GET /api/v2305.1/odata

### Description
Retrieves data records using the OData endpoint.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/odata

### Response
#### Success Response (200)
- **data** (array) - List of data records.

#### Response Example
{
  "data": []
}
```

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

### Get list of export tasks with curl GET

Source: https://help.anaplan.com/start-the-export-03d2acc9-0305-42c3-816e-15629133e9c5

Use this curl command to retrieve a list of export tasks. It requires the same URL parameters and authentication as the POST example.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/exports/{exportId}/tasks \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}' \
 -H 'Content-Type:application/json'
```

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

### Install the add-in with /i option

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

Use this command to install the add-in. The /i option is a universal Windows Installer option that specifies installation.

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

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

### Install to a specified directory with APPDIR option

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

Use this command to install the add-in to a specified directory. The APPDIR option sets the installation directory.

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

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

### GET /api/v2305.1/models/Consolidations/Dimensions

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

Example of a request to retrieve a list of dimensions within a specific model.

```APIDOC
## GET /api/v2305.1/models/Consolidations/Dimensions

### Description
Retrieves a list of dimensions within the Consolidations model.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/models/Consolidations/Dimensions

### Parameters
#### Path Parameters
- **Consolidations** (string) - Required - The model name.
- **Dimensions** (string) - Required - The resource path for dimensions.

### Response
#### Success Response (200)
- **dimensions** (array) - List of dimensions.

#### Response Example
{
  "dimensions": []
}
```

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

### Response example with application/json and includeAll=true

Source: https://help.anaplan.com/retrieve-list-data-2309ce30-9f81-40d4-a7c3-473a8ff60667

Example response body when the Accept header is application/json and includeAll is true. The response includes additional fields subsets and properties for each list item.

```json
{
    "meta": {
        "schema": "https://api.anaplan.com/2/0/objects/list"
    },
    "status": {
        "code": 200,
        "message": "Success"
    },
    "listItems": [
      {
        "id": "206000000001",
        "name": "cake",
        "code": "c1",
        "subsets": {
          "favourite": true
        },
        "properties": {
          "count": "1.0"
        }
      },
      {
        "id": "206000000002",
        "name": "bread",
        "code": "b2",
        "subsets": {
          "favourite": false
        },
        "properties": {
          "count": "4.0"
        }
      },
      {
        "id": "206000000003",
        "name": "pastry",
        "code": "p3",
        "subsets": {
          "favourite": true
        },
        "properties": {
          "count": "5.0"
        }
      }
    ]
  }
```

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

### GET /api/v2305.1/odata/ClientSchemaTable

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

Example of a valid API request to retrieve a client schema table using the OData endpoint.

```APIDOC
## GET /api/v2305.1/odata/ClientSchemaTable

### Description
Retrieves a client schema table using the OData endpoint.

### Method
GET

### Endpoint
https://fluenceapi-prod.fluence.app/api/v2305.1/odata/ClientSchemaTable

### Parameters
#### Path Parameters
- **ClientSchemaTable** (string) - Required - The name of the client schema table to retrieve.

### Response
#### Success Response (200)
- **data** (object) - The client schema table data.

#### Response Example
{
  "data": {}
}
```

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

### POST /process/start/

Source: https://help.anaplan.com/start-workflow-process-0e412efb-e168-4c94-818f-bb6bc550f493

Starts a workflow process within the specified folder(s) in the Explorer module. The request body should contain parameters for the start task or an empty array.

```APIDOC
## POST /process/start/

### Description
Use this method to command the Anaplan Financial Consolidation server to start a workflow process within the specified folder(s) in the Explorer module.

### Method
POST

### Endpoint
`/process/start/{path}/{name_of_workflow}`

### Parameters
#### Path Parameters
- **{path}** (string) - Required - The path to the workflow file in Explorer. Example: `ImportsandExports`
- **{name_of_workflow}** (string) - Required - The name of the workflow file in Explorer. Example: `ModelExport`

#### Request Body
- The request body should contain the parameters for the start task within the workflow process, or type `[]`.

### Request Example
```
curl --location POST 'https://fluenceapi-prod.fluence.app/api/v2305.1/process/start/ImportsandExports/ModelExport' \
--header 'TENANT: CustomerTenant' \
--header 'X-API-TOKEN: 73ca5973-ce3e-4cc6-b2d4-b09a99770ccf'
```

### Response
#### Success Response (200)
A `200 OK` response is generated if successful.

### Notes
Special characters such as `?`, `&`, and `/` are not recommended in the names of Explorer module folders or Workflow processes.
```

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

### Enable EXE installation logging for Anaplan XL Reporting Web Edition

Source: https://help.anaplan.com/06264b8a-e6be-4129-9c03-885993ed4d52

Use this command to log installation errors when running the bootstrapper executable (EXE). The /ComponentArgs switch passes the logging arguments to the MSI component, writing a verbose log to the specified file path.

```text
Anaplan XL ReportingWebEdition.exe /ComponentArgs "Anaplan XL Reporting Web Edition":"/l*v C:\log.txt"
```

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

### Initialize repository and get top-level folder

Source: https://help.anaplan.com/web-development-in-anaplan-xl-web-ff5db17c-52ac-44bc-8ebe-842ae566af2f

Initializes Anaplan XL, creates a repository object, and queries the server asynchronously. The callback receives the top-level folder; replace MyServerName with the actual Anaplan XL web site.

```javascript
<script>function loadFluenceXL(){ //Initialise Anaplan XL var xlcubedOptions = { BaseUrl:"http://MyServerName" }; XLCubed.Settings.Init(xlcubedOptions); //create a repository object var oRep = new XLCubed.Repository(); //and query the server. //This is asynchronous, so pass in a callback to handle the results oRep.GetRepository( function(oTopFolder) { alert(oTopFolder.folders.length); });}</script>
```

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

### Response 200 for getting tasks

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

Example JSON response returned when listing tasks. Shows taskId, taskState, and creationTime.

```json
{
    "taskId":"BAB7819744034F25BF73EA1B41804478",
    "taskState":"IN_PROGRESS",
    "creationTime":1535145539157
 }
```

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

### Set SPNs for Web Server - Example

Source: https://help.anaplan.com/9dbca7be-7c69-4380-8239-3009a4f0a584

Example of setting SPNs for a web server using a domain account. Replace webserver and domain\appooluser with actual values.

```text
setspn -S http/webserver domain\appooluser setspn -S http/webserver.domain.com domain\appooluser
```

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

### Curl example for GET /workspaces?tenantDetails=true

Source: https://help.anaplan.com/list-user-workspaces-c324d0af-01ce-4e6b-8039-06289a4f5b19

Use this curl command to list all workspaces the user can access in their default tenant. The tenantDetails=true query parameter returns an estimate of the current size (currentSize) and the allotted quota (sizeAllowance). Replace {anaplan_auth_token} with a valid Anaplan authentication token.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/workspaces?tenantDetails=true \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}'
```

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

### Extract MSI with wix burn extract

Source: https://help.anaplan.com/anaplan-xl-msi-installation-45a17574-e7f9-4507-b39b-ad4e840f99c7

Run this command at the command line to extract the Windows Installer MSI from the AnaplanXLReporting.exe setup executable. Replace AnaplanXLReporting.exe with the full path to the setup executable. The MSI is extracted into a subdirectory called SupportFiles\WixAttachedContainer.

```shell
wix burn extract AnaplanXLReporting.exe -out SupportFiles -outba SupportFiles
```

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

### Create symbolic link to share repository

Source: https://help.anaplan.com/configure-dual-authentication-for-anaplan-xl-web-50173fb4-2619-4c69-968f-73d6dfd30a2c

Run this command in an administrative Command Prompt to replace the new website's Repository folder with a symbolic link pointing to the original repository. This step is not needed if using the SQL repository.

```plaintext
MKLink /D Repository c:\inetpub\wwwroot\AnaplanXLWeb\repository
```

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

### Response 200 (application/json) for GET /models/{modelId}

Source: https://help.anaplan.com/8baa6c1e-265f-440b-af26-1963fb88474c

Example response when modelDetails is not set or false. Contains model metadata and status.

```json
{
  "meta": {
    "schema": "https://api.anaplan.com/2/0/objects/model"
  },
  "model": {
    "id": "FC12345678912343455667",
    "activeState": "UNLOCKED",
    "name": "PF&A",
    "currentWorkspaceId": "8a8b8c8d8e8f8g8i",
    "currentWorkspaceName": "Financial Planning",
    "modelUrl": "https://rt.anaplan.com/anaplan/rt?selectedWorkspaceId\8a8b8c8d8e8f8g8i\u0026selectedModelId\FC12345678912343455667",
    "categoryValues": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  }
}
```

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

### Response example with application/json and includeAll=false

Source: https://help.anaplan.com/retrieve-list-data-2309ce30-9f81-40d4-a7c3-473a8ff60667

Example response body when the Accept header is application/json and includeAll is false. The response contains list items with id, name, and code fields.

```json
{
    "meta": {
        "schema": "https://api.anaplan.com/2/0/objects/list"
    },
    "status": {
        "code": 200,
        "message": "Success"
    },
    "listItems": [
      {
        "id": "206000000001",
        "name": "cake",
        "code": "c1"
      },
      {
        "id": "206000000002",
        "name": "bread",
        "code": "b2"
      },
      {
        "id": "206000000003",
        "name": "pastry",
        "code": "p3"
      }
    ]
  }
```

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

### GET /process/start/ImportandExports/Data/ModelExport

Source: https://help.anaplan.com/bcddc03e-9c46-4174-9bae-347cf77a45d4

Start a process workflow for importing and exporting data, specifically for model export. This endpoint manages process workflows.

```APIDOC
## GET /process/start/ImportandExports/Data/ModelExport

### Description
Start a process workflow for importing and exporting data, specifically for model export. This endpoint manages process workflows.

### Method
GET

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

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

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

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

### GET /scim/1/0/v2/Users

Source: https://help.anaplan.com/how-to-implement-scim-6f127888-9b62-4ff1-8c5b-7a91be0f2d66

Example call to the SCIM Users endpoint using an Anaplan auth token. The Authorization header contains the token value.

```APIDOC
## GET /scim/1/0/v2/Users

### Description
Example call to the SCIM Users endpoint using an Anaplan auth token.

### Method
GET

### Endpoint
https://api.anaplan.com/scim/1/0/v2/Users

### Parameters
#### Headers
- **Authorization** (string) - Required - Header format: `Authorization: AnaplanAuthToken <token_value>`

### Request Example
```
curl -X GET \
  -H 'Authorization: AnaplanAuthToken _exampletokenvalue_' \
  https://api.anaplan.com/scim/1/0/v2/Users
```

### Response
No response details provided in the source.

```

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

### Response example for process dump download

Source: https://help.anaplan.com/download-the-process-dump-file-ffa228d0-2cc7-4e7f-9e95-279a4da30ecd

Example response body returned by the download request. It contains CSV-like data with headers and error messages for invalid rows.

```text
"_Status_","Column 1","Parent","Code","Start Date","Leave Date","Column 6","Column 7","Start Datesss","Column 9","Column 10","Column 11","_Line_","_Error_1_"
"W","Max Warren",",,","","4/16/12","","","","4/16/12","","","","151","Invalid parent"
"W","Carolyn Tabor","Supply Chain","",",,,","6/30/09","","","6/30/06","","","","153","Invalid date: ,,,"
"E","","Parent","Code","Start Date","Leave Date","","","Start Datesss","","","","11522","Invalid name: Code"
"E","","Parent","Code","Start Date","Leave Date","","","Start Datesss","","","","23043","Invalid name: Code"
```

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

### GET /scim/1/0/v2/Users

Source: https://help.anaplan.com/how-to-implement-scim-6f127888-9b62-4ff1-8c5b-7a91be0f2d66

Example call to the SCIM Users endpoint using Basic Authentication. The Authorization header contains a Base64-encoded username and password.

```APIDOC
## GET /scim/1/0/v2/Users

### Description
Example call to the SCIM Users endpoint using Basic Authentication.

### Method
GET

### Endpoint
https://api.anaplan.com/scim/1/0/v2/Users

### Parameters
#### Headers
- **Authorization** (string) - Required - Header format: `Authorization: BASIC <username:password base64 encoded>`

### Request Example
```
curl -X GET \
  -H 'Authorization: BASIC dXNlcm5hbWU6cGFzc3dvcmQ=' \
  https://api.anaplan.com/scim/1/0/v2/Users
```

### Response
No response details provided in the source.

```

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

### Response example for assigning user roles

Source: https://help.anaplan.com/assign-user-roles-c0dabed5-b2c3-448f-813d-36e724bd5775

Example response showing the list of all roles after a successful assignment. If the user already had the Admin role, the response lists all roles, existing and new.

```json
[
    "Admin",
    "Controller",
    "Reviewer"
]
```

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

### Start process with curl POST

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

Use this curl command to start a process. Replace {workspaceId}, {modelId}, {processId}, and {anaplan_auth_token} with actual values. The request body includes localeName set to en_US.

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

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

### Response 200 for create action

Source: https://help.anaplan.com/cb492bdf-5e59-4d3e-aa43-16d4431eddf2

Example response for a create action (SIMPLE_CREATE). Shows actionType and name.

```json
{
   "meta": {
       "schema": "https://api.anaplan.com/2/0/models/F7F3D1004C214A00A44C1655DE413B50/objects/action"
   },
   "status": {
       "code": 200,
       "message": "Success"
   },
   "action": {
       "id": "117000000008",
       "actionType": "SIMPLE_CREATE",
       "name": "Create Action"
   }
 }
```

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

### XLCubed.Settings.Init

Source: https://help.anaplan.com/web-development-in-anaplan-xl-web-ff5db17c-52ac-44bc-8ebe-842ae566af2f

Initializes the Anaplan XL web settings with the base URL of the Anaplan XL website.

```APIDOC
## XLCubed.Settings.Init

### Description
Initializes the Anaplan XL web settings with the base URL of the Anaplan XL website.

### Method
JavaScript function call

### Parameters
- **xlcubedOptions** (object) - Required - An object containing the `BaseUrl` property.
  - `BaseUrl` (string) - Required - The base URL of the Anaplan XL website.

### Example
```javascript
var xlcubedOptions = { BaseUrl: "http://MyServerName" };
XLCubed.Settings.Init(xlcubedOptions);
```
```

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

### Response 200 for GET /users/me

Source: https://help.anaplan.com/d5e7ae19-0a8a-44a7-a482-bdee7479e039

Example JSON response returned when the request is successful. Contains user details such as id, email, and status.

```json
{
  "meta":{
    "schema":"https://api.anaplan.com/2/0/objects/user"
  },
  "user":{
    "id":"8a8b844a477d5da70147d150ee080b17",
    "active":true,
    "email":"a.user@anaplan.com",
    "emailOptIn":true,
    "firstName":"A",
    "lastName":"User",
    "customerId":"8b81da6f5fb6b75701604d6c950c05b1",
    "lastLoginDate":"2017-09-07T08:05:37.000+0000"
  },
  "status":{
    "code":200,
    "message":"Success"
  }
}
```

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

### GET /scim/1/0/v2/Users

Source: https://help.anaplan.com/how-to-implement-scim-6f127888-9b62-4ff1-8c5b-7a91be0f2d66

Example call to the SCIM Users endpoint using an API key as a bearer token. The Authorization header contains the API key.

```APIDOC
## GET /scim/1/0/v2/Users

### Description
Example call to the SCIM Users endpoint using an API key as a bearer token.

### Method
GET

### Endpoint
https://api.anaplan.com/scim/1/0/v2/Users

### Parameters
#### Headers
- **Authorization** (string) - Required - Header format: `Authorization: Bearer <API key>`

### Request Example
```
curl -X GET \
  -H 'Authorization: Bearer my-secure-api-key' \
  https://api.anaplan.com/scim/1/0/v2/Users
```

### Response
No response details provided in the source.

```

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

### Run MSI file with msiexec command

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

Use this command to run the MSI file and display the Windows Installer dialog with a full list of installation options. Replace the file path with the actual location of the MSI file.

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

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

### Response 200 (application/json) for get task information

Source: https://help.anaplan.com/ae734b14-4f61-4cfa-9e16-4d84b9500dda

Example JSON response for a successful task information request. The taskState is COMPLETE and successful is true.

```json
{
   "task":{
      "type":"taskInformation",
      "taskId":"0690AA1C761F48549C3442A02F91D962",
      "currentStep":"Complete.",
      "progress":1,
      "result":{
         "failureDumpAvailable":false,
         "objectId":"117000000019",
         "successful":true
      },
      "taskState":"COMPLETE"
   }
}
```

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

### Response example with text/csv and includeAll=true

Source: https://help.anaplan.com/retrieve-list-data-2309ce30-9f81-40d4-a7c3-473a8ff60667

Example response body when the Accept header is text/csv and includeAll is true. The response is a CSV with columns id, name, code, parent, parentId, listId, listName, favourite, count.

```csv
id,name,code,parent,parentId,listId,listName,favourite,count
206000000001,cake,c1,,,,true,1.0
206000000002,bread,b2,,,,false,4.0
206000000003,pastry,p3,,,,true,5.0
```

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

### Curl example for retrieving Optimizer action log

Source: https://help.anaplan.com/7e4dc987-4b11-491d-91de-046fc2c8947a

Use this curl command to download the Anaplan Optimizer solution log. Requires a valid authentication token, the Optimizer action ID, and the correlation ID from the Anaplan UI. The response is plain text.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/workspaces/{workspaceId}/models/{modelId}/optimizeActions/{actionId}/tasks/{correlationId}/solutionLogs \
 -H 'Authorization: AnaplanAuthToken {anaplan_auth_token}'
 -H 'Accept:text/plain'
```

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

### Curl example for GET /models

Source: https://help.anaplan.com/9287c44b-7383-4ff2-b6fb-da34d77c6017

Use this curl command to retrieve model information. The endpoint is https://api.anaplan.com/2/0/models and requires an authorization header with an AnaplanAuthToken.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/models \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}'
```

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

### Response 200 for start deletion task

Source: https://help.anaplan.com/e085ce2c-861c-4b1a-9842-4da010773ae6

Example JSON response returned when the deletion task is successfully initiated. Contains the taskId of the created task.

```json
{
   "task":{
      "taskId":"0690AA1C761F48549C3442A02F91D962"
   }
}
```

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

### Curl example for GET /models/{modelId}

Source: https://help.anaplan.com/8baa6c1e-265f-440b-af26-1963fb88474c

Use this curl command to retrieve model information. Replace {modelId} with the model ID and {anaplan_auth_token} with your authentication token.

```bash
curl -X GET \
 https://api.anaplan.com/2/0/models/{modelId} \
 -H 'authorization: AnaplanAuthToken {anaplan_auth_token}'
```

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

### Set installation location with bootstrapper

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

Use this command to specify a custom installation folder when using the .exe bootstrapper.

```plaintext
AnaplanXLReporting.exe INSTALLLOCATION="C:\My Install Folder"
```