REST API for Oracle Essbase

All REST Endpoints

The operations from the AI category.

AI Pass Through: Method: post
Path: /ai/applications/{applicationName}/chat/passThrough
Associate AI Connection: Method: post
Path: /ai/applications/{applicationName}/connection/{connectionName}
Chat with Ask Essbase: Method: get
Path: /ai/aiconnection/{aiConnectionName}/vectorindex/{vectorIndexName}/narrate/{profileName}
Check If Ask Essbase Is Enabled: Method: get
Path: /ai/vectorindex
Create OCI Chat Credential using Signing Key: Method: post
Path: /ai/dbconnection/{dbConnectionName}/chat/credential/signingkey/{credentialName}
Create OCI Chat Profile: Method: post
Path: /ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}
Create OCI Vector Credential: Method: post
Path: /ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}
Delete Calculation-specific Conversation: Method: delete
Path: /ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation/{conversationId}
Delete Conversation History: Method: delete
Path: /ai/applications/{applicationName}/databases/{databaseName}/conversationHistory
Delete OCI Chat Credential: Method: delete
Path: /ai/dbconnection/{dbConnectionName}/chat/credential/{credentialName}
Delete OCI Chat Profile: Method: delete
Path: /ai/aiconnection/{aiConnectionName}/chat/profile/{profileName}
Delete OCI Vector Credential: Method: delete
Path: /ai/dbconnection/{dbConnectionName}/vector/credential/{credentialName}
Disable Ask Essbase: Method: delete
Path: /ai/aiconnection/{aiConnectionName}/job/vectorindex
Dissociate AI Connection: Method: delete
Path: /ai/applications/{applicationName}/connection
Enable Ask Essbase: Method: post
Path: /ai/aiconnection/{aiConnectionName}/job/vectorindex
Generate Calculation Script: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/calculation/generate
Get AI Connection: Method: get
Path: /ai/connection
Get Calculation-specific Conversation History: Method: get
Path: /ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation/{conversationId}
Get Conversation History: Method: get
Path: /ai/applications/{applicationName}/databases/{databaseName}/conversationHistory
List Calculation-specific Conversations IDs: Method: get
Path: /ai/applications/{applicationName}/databases/{databaseName}/calculation/conversation
List Conversations: Method: get
Path: /ai/applications/{applicationName}/databases/{databaseName}/conversation
List Sample Queries: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/listSampleQueries
MDX Generator: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/mdxgenerator
N-Nearest-Neighbour Search: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/nnearestneighboursearch
Semantic Search: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/semanticsearch
Vectorization Date: Method: post
Path: /ai/applications/{applicationName}/databases/{databaseName}/vectorizationDate
Vectorize Outline Job: Method: post
Path: /ai/applications/{applicationName}/job/vectorize/databases/{databaseName}

About Essbase

The operations from the About Essbase category.

About Essbase: Method: get
Path: /about
About Essbase Instance: Method: get
Path: /about/instance

Aggregate Storage Load Buffers

The operations from the Aggregate Storage Load Buffers category.

Create Buffer: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/asodataload/buffers
Destroy Dataload Buffer: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/asodataload/buffers
List Buffers: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/asodataload/buffers
Merge Data: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/asodataload/actions/merge

Application Configuration

The operations from the Application Configuration category.

Add Application Configuration: Method: post
Path: /applications/{applicationName}/configurations
Delete Application Configuration: Method: delete
Path: /applications/{applicationName}/configurations/{configId}
Get Application Configuration: Method: get
Path: /applications/{applicationName}/configurations
Get Application Configuration Filtered: Method: get
Path: /applications/{applicationName}/configurationkeys
Get Application Configuration Property: Method: get
Path: /applications/{applicationName}/configurations/{configId}
Update Application Configuration: Method: put
Path: /applications/{applicationName}/configurations/{configId}
Update Application Configurations: Method: put
Path: /applications/{applicationName}/configurations

Application Connections

The operations from the Application Connections category.

Create Application Connection: Method: post
Path: /applications/{applicationName}/connections
Delete Application Connection: Method: delete
Path: /applications/{applicationName}/connections/{connectionName}
Get Application Connection: Method: get
Path: /applications/{applicationName}/connections/{connectionName}
List Application Connections: Method: get
Path: /applications/{applicationName}/connections
Test New Application Connection: Method: post
Path: /applications/{applicationName}/connections/actions/test
Test Saved Application Connection: Method: post
Path: /applications/{applicationName}/connections/{connectionName}/actions/test
Update Application Connection: Method: put
Path: /applications/{applicationName}/connections/{connectionName}
Upload Application Connection Wallet File: Method: put
Path: /applications/{applicationName}/connections/{connectionName}/wallet

Application Datasources

The operations from the Application Datasources category.

Create Application Datasource: Method: post
Path: /applications/{applicationName}/datasources
Delete Application Datasource: Method: delete
Path: /applications/{applicationName}/datasources/{datasourceName}
Get Application Datasource: Method: get
Path: /applications/{applicationName}/datasources/{datasourceName}
Get Application Datasources: Method: get
Path: /applications/{applicationName}/datasources
Get Streamed Datasource Results: Method: post
Path: /applications/{applicationName}/datasources/query/stream
Update Application Datasource: Method: put
Path: /applications/{applicationName}/datasources/{datasourceName}

Application Logs

The operations from the Application Logs category.

Download All Application Logs: Method: get
Path: /applications/{applicationName}/logs/all
Download Application Logs: Method: get
Path: /applications/{applicationName}/logs
Download Latest Application Log: Method: get
Path: /applications/{applicationName}/logs/latest

Application Role Provisioning

The operations from the Application Role Provisioning category.

Deprovision User or Group from Application: Method: delete
Path: /applications/{app}/permissions/{id}
Get Application Role Provisioning: Method: get
Path: /applications/{app}/permissions/{id}
Import Application Role Provisioning: Method: post
Path: /applications/{app}/permissions
Provision Application Role to User or Group: Method: put
Path: /applications/{app}/permissions/{id}
Search Application Role Provisioning: Method: get
Path: /applications/{app}/permissions

Application Settings and Statistics

The operations from the Application Settings and Statistics category.

Get Application General Settings: Method: get
Path: /applications/{applicationName}/settings
Get Application Security Settings: Method: get
Path: /applications/{applicationName}/settings/security
Get Application Startup Settings: Method: get
Path: /applications/{applicationName}/settings/startup
Get Application Statistics: Method: get
Path: /applications/{applicationName}/statistics
Update Application Settings: Method: patch
Path: /applications/{applicationName}/settings

Applications

The operations from the Applications category.

Copy Application: Method: post
Path: /applications/actions/copy
Copy Database: Method: post
Path: /applications/{applicationName}/databases/actions/copy
Create Application and Database: Method: post
Path: /applications
Create Shadow Application: Method: post
Path: /applications/actions/shadowCopy
Decrypt Application: Method: post
Path: /applications/{applicationName}/decrypt
Delete Application: Method: delete
Path: /applications/{applicationName}
Delete Database: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}
Delete Shadow Application: Method: delete
Path: /applications/actions/shadowDelete/{shadowAppName}
Encrypt Application: Method: post
Path: /applications/{applicationName}/encrypt
Execute Report Script: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/executeReport
Get Application: Method: get
Path: /applications/{applicationName}
Get Application Provisioning Report: Method: get
Path: /applications/{applicationName}/provisionReport
Get Application Tree View: Method: get
Path: /applications/actions/tree
Get Calculation Functions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/calculationFunctions
Get Currency Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/currencySettings
Get Database: Method: get
Path: /applications/{applicationName}/databases/{databaseName}
Get Encryption Info: Method: get
Path: /applications/{applicationName}/encryptionconfig
Get Formula Functions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/formulaFunctions
Get MDX Functions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/mdxFunctions
Get Supported Partition Types: Method: get
Path: /applications/partitions/supportedfederatedtypes
List Active Aliases: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias
List Aliases: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/aliases
List Aliases: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/aliases/setActiveAlias
List Application Names: Method: get
Path: /applications/actions/name/{appVisiblity}
List Applications: Method: get
Path: /applications
List Databases: Method: get
Path: /applications/{applicationName}/databases
Promote Shadow Application: Method: post
Path: /applications/actions/shadowPromote
Rename Application: Method: post
Path: /applications/actions/rename
Rename Database: Method: post
Path: /applications/{applicationName}/databases/actions/rename
Set Currency Settings: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/currencySettings
Start or Stop Application: Method: put
Path: /applications/{applicationName}
Start or Stop Database: Method: put
Path: /applications/{applicationName}/databases/{databaseName}

Audit Trail

The operations from the Audit Trail category.

Delete Audit Data: Method: delete
Path: /applications/{application}/databases/{database}/audittrail/data
Get Audit Data: Method: get
Path: /applications/{application}/databases/{database}/audittrail/data

Batch Outline Editing

The operations from the Batch Outline Editing category.

Run Batch Outline Edit: Method: post
Path: /applications/{application}/databases/{database}/boe

CentralizedURL

The operations from the CentralizedURL category.

Add Essbase Server to Centralized URL List: Method: post
Path: /centralizedurl
Delete Essbase Server URL from Centralized URL List: Method: delete
Path: /centralizedurl
Get Essbase Server List: Method: get
Path: /centralizedurl
Update Essbase Server in Centralized URL List: Method: put
Path: /centralizedurl

Cube designer

The operations from the Cube designer category.

Analyze Schema: Method: post
Path: /cubedesigner/analyze
Cleanup Sessions: Method: post
Path: /cubedesigner/sessions/cleanup
Create Session: Method: post
Path: /cubedesigner/session
Delete Session: Method: delete
Path: /cubedesigner/session
Deploy Cube: Method: post
Path: /cubedesigner/deploy
Discover Relations Between Two Or More Tables: Method: post
Path: /cubedesigner/discover
Export Cube Creator Template: Method: post
Path: /cubedesigner/export-osi
Get Analyze Logs: Method: get
Path: /cubedesigner/analyze-logs
Get Pipeline Logs: Method: get
Path: /cubedesigner/logs
Get Pipeline Result: Method: get
Path: /cubedesigner/result
Import OSI Schema: Method: post
Path: /cubedesigner/import-osi
List Personas: Method: get
Path: /cubedesigner/personas
List Scenarios: Method: post
Path: /cubedesigner/recommend
List Scenarios: Method: get
Path: /cubedesigner/scenarios
List Sessions: Method: get
Path: /cubedesigner/sessions
Validate Connection: Method: post
Path: /cubedesigner/validate
Validate OSI Schema: Method: post
Path: /cubedesigner/validate-osi-schema

Database Settings and Statistics

The operations from the Database Settings and Statistics category.

Export Query Tracking: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/settings/querytracking/export
Get ASO Compression Info: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/compressioninfo
Get Attribute Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/outline/attributes
Get Buffer Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/buffers
Get Cache Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/caches
Get Calculation Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/calculation
Get Compression Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/compression
Get Date Formats: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/outline/dateformats
Get General Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings
Get General Statistics: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/statistics
Get Outline Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/outline
Get Runtime Statistics: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/statistics/runtime
Get Startup Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/startup
Get Storage Statistics: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/statistics/storage
Get Transaction Settings: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/settings/transactions
Import Query Tracking: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/settings/querytracking/import
Update Outline Settings: Method: patch
Path: /applications/{applicationName}/databases/{databaseName}/settings/outline
Update Settings: Method: patch
Path: /applications/{applicationName}/databases/{databaseName}/settings

Database Size Statistics

The operations from the Database Size Statistics category.

Get Database Size Statistics: Method: get
Path: /databasesizestatistics

Dimensions

The operations from the Dimensions category.

Get Generation: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/generations/{generationNumber}
Get Level: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels/{levelNumber}
List Dimensions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/dimensions
List Generations: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/generations
List Levels: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels
Update Generation: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/generations/{generationNumber}
Update Level: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/dimensions/{dimensionName}/levels/{levelNumber}

Drill Through Reports

The operations from the Drill Through Reports category.

Create Drill Through Report: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/reports
Delete Drill Through Report: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/reports/{name}
Execute Drill Through Report: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/reports/{name}
Get Drill Through Report: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/reports/{name}
Get Drill Through Reports: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/reports
List Drill Through Reports for Given Cell Intersections: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dtreports/list
Update Drill Through Report: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/reports/{name}

The operations from the Email category.

Add Imap Configuration: Method: put
Path: /email/imap
Add Smtp Configuration: Method: put
Path: /email/smtp
Delete Imap Configuration: Method: delete
Path: /email/imap
Delete Smtp Configuration: Method: delete
Path: /email/smtp
Get Email Configuration: Method: get
Path: /email
Get Imap Configuration: Method: get
Path: /email/imap
Get Smtp Configuration: Method: get
Path: /email/smtp

Essbase Configuration

The operations from the Essbase Configuration category.

Get Essbase Configuration: Method: get
Path: /cfg

Execute MDX

The operations from the Execute MDX category.

Run MDX Query: Method: post
Path: /applications/{application}/databases/{database}/mdx
Run MDX Report: Method: get
Path: /applications/{application}/databases/{database}/mdx/{name}

File Scanner

The operations from the File Scanner category.

Delete Antivirus: Method: delete
Path: /filescanner
Get Antivirus: Method: get
Path: /filescanner
Set Antivirus: Method: put
Path: /filescanner
Validate Antivirus: Method: post
Path: /filescanner/actions/validate

Files

The operations from the Files category.

Abort Multipart File Upload: Method: delete
Path: /files/abort/{path}
Commit Multipart File Upload: Method: post
Path: /files/upload-commit/{path}
Copy File: Method: post
Path: /files/actions/copy
Create Multipart File Upload: Method: post
Path: /files/upload-create/{path}
Delete File Or Folder: Method: delete
Path: /files/{path}
Extract Zip File: Method: post
Path: /files/actions/extract
Extract Zip File Using Job: Method: post
Path: /files/actions/extractJob
Get Database Names from LCM Zip File: Method: get
Path: /files/getDatabasesFromLCMZip
Get Home Path: Method: get
Path: /files/homepath
Get Object Storage Uri: Method: get
Path: /files/getobjectstoreuri
Get Shared Path: Method: get
Path: /files/sharedpath
Get Upload Configuration: Method: get
Path: /files/uploadconfig
List or Download Files: Method: get
Path: /files/{path}
List Root Folders: Method: get
Path: /files
Move or Rename File: Method: post
Path: /files/actions/move
Upload File Or Create Folder: Method: put
Path: /files/{path}
Upload File Part: Method: put
Path: /files/upload-part/{path}

Filters

The operations from the Filters category.

Add Permissions in Filter: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions
Copy Filter: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/filters/filterops/copy
Create Filter: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/filters
Delete Filter: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}
Delete Permission from Filter: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions/{userGroupId}
Get Filter: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}
Get Filter Rows: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}/rows
Get Filters: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/filters
Get Permissions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions
Rename Filter: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/filters/filterops/rename
Replace Filter Permissions: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}/permissions
Update Filter: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/filters/{filterName}
Validate Filter: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/filters/filterops/validate

Global Connections

The operations from the Global Connections category.

Clone Connection: Method: post
Path: /connections/clone
Create Global Connection: Method: post
Path: /connections
Delete Global Connection: Method: delete
Path: /connections/{connectionName}
Get Global Connection: Method: get
Path: /connections/{connectionName}
List Dependent Connection Names: Method: get
Path: /connections/{connection}/getdependentconnections
List Global Connections: Method: get
Path: /connections
Test New Global Connection: Method: post
Path: /connections/actions/test
Test Saved Global Connection: Method: post
Path: /connections/{connectionName}/actions/test
Update Global Connection: Method: put
Path: /connections/{connectionName}
Upload Global Connection Wallet File: Method: put
Path: /connections/{connectionName}/wallet

Global Datasources

The operations from the Global Datasources category.

Create Global Datasource: Method: post
Path: /datasources
Delete Global Datasource: Method: delete
Path: /datasources/{datasourceName}
Get Global Datasource: Method: get
Path: /datasources/{datasourceName}
Get Global Datasources: Method: get
Path: /datasources
Get Streamed Global Datasource Results: Method: post
Path: /datasources/customdelimited/query/stream
Get Streamed Global Datasource Results: Method: post
Path: /datasources/query/stream
Get Streamed Global Datasource Results By ID: Method: get
Path: /datasources/query/data/{streamId}
Stream Global Datasource Results: Method: post
Path: /datasources/query
Update Global Datasource: Method: put
Path: /datasources/{datasourceName}

Grid

The operations from the Grid category.

Execute Grid Layout: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/grid/layout/{layout}
Execute Grid Operation: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/grid
Execute MDX Report: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/grid/mdx
Get Default Grid: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/grid
Get Layout Grid: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/grid/layout

Grid Preferences

The operations from the Grid Preferences category.

Get Grid Preferences: Method: get
Path: /preferences/grid
Set Grid Preferences: Method: put
Path: /preferences/grid

Group Provisioning Report

The operations from the Group Provisioning Report category.

Get All Applications Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport/applications
Get Application Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport/applications/{application}
Get Application Roles Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport/applications/{application}/roles
Get Filters Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport/applications/{application}/filters
Get Full Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport
Get Scripts Provisioning Report: Method: get
Path: /groups/{groupId}/provisionReport/applications/{application}/scripts

Groups

The operations from the Groups category.

Add Group Users: Method: post
Path: /groups/{id}/members/users
Add Groups to Group: Method: post
Path: /groups/{id}/members/groups
Add or Import Groups: Method: post
Path: /groups
Delete Group: Method: delete
Path: /groups/{id}
Delete Groups in File: Method: post
Path: /groups/actions/delete
Get Group: Method: get
Path: /groups/{id}
Get Group Members: Method: get
Path: /groups/{id}/members
Get Group Users: Method: get
Path: /groups/{id}/members/users
Get Groups in Group: Method: get
Path: /groups/{id}/members/groups
Remove Group Users: Method: delete
Path: /groups/{id}/members/users
Remove Groups from Group: Method: delete
Path: /groups/{id}/members/groups
Search or Export Groups: Method: get
Path: /groups
Update Group: Method: put
Path: /groups/{id}

Jobs

The operations from the Jobs category.

Delete Jobs: Method: delete
Path: /jobs/purge
Execute Job: Method: post
Path: /jobs
Get Job: Method: get
Path: /jobs/{id}
Get Job List: Method: get
Path: /jobs
Get Job Statistics: Method: get
Path: /jobs/statistics/{userId}
Rerun Job: Method: post
Path: /jobs/{id}

Layouts

The operations from the Layouts category.

Delete Grid Layout: Method: delete
Path: /applications/{application}/databases/{database}/layouts/{layout}
Get Grid Layout Details: Method: get
Path: /applications/{application}/databases/{database}/layouts/{layout}
List Grid Layouts: Method: get
Path: /applications/{application}/databases/{database}/layouts
Mark Grid Layout as Default: Method: post
Path: /applications/{application}/databases/{database}/layouts/{layout}/actions/markDefault
Save Grid Layout: Method: post
Path: /applications/{application}/databases/{database}/layouts
Update Grid Layout: Method: put
Path: /applications/{application}/databases/{database}/layouts/{layout}

Location Aliases

The operations from the Location Aliases category.

Create Location Alias: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/locationaliases
Delete Location Alias: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/locationaliases/{aliasName}
Get Location Alias: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/locationaliases/{aliasName}
Get Location Aliases: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/locationaliases
Update Location Alias: Method: patch
Path: /applications/{applicationName}/databases/{databaseName}/locationaliases/{aliasName}

Locks

The operations from the Locks category.

List Locked Blocks: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/locks/blocks
List Locked Objects: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/locks/objects
List Locks: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/locks
Lock Object: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/locks/objects/lock
Unlock Block: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/locks/blocks/unlock
Unlock Object: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/locks/objects/unlock

MDX Reports

The operations from the MDX Reports category.

Delete MDX Report: Method: delete
Path: /applications/{application}/databases/{database}/queries/{query}
Get MDX Report Details: Method: get
Path: /applications/{application}/databases/{database}/queries/{query}
List MDX Reports: Method: get
Path: /applications/{application}/databases/{database}/queries
Rename MDX Report: Method: put
Path: /applications/{application}/databases/{database}/queries/rename
Save MDX Report: Method: post
Path: /applications/{application}/databases/{database}/queries
Update MDX Report: Method: put
Path: /applications/{application}/databases/{database}/queries/{query}

Object Storage Configuration

The operations from the Object Storage Configuration category.

Create or Update Object Storage Configuration: Method: put
Path: /cloudstorage/config
Get Object Storage Configuration: Method: get
Path: /cloudstorage/config
Verify Object Storage Configuration: Method: post
Path: /cloudstorage/config/test

Outline Viewer

The operations from the Outline Viewer category.

Export Outline To XML: Method: post
Path: /outline/{app}/{cube}/xml
Get Descendant Count: Method: get
Path: /outline/{app}/{cube}/descendantsCount/{memberUniqueName}
Get Dimensions Children or Search: Method: get
Path: /outline/{app}/{cube}
Get Member Ancestors: Method: get
Path: /outline/{app}/{cube}/ancestors/{memberUniqueName}
Get Member Info: Method: get
Path: /outline/{app}/{cube}/{memberUniqueName}
Get Pivot Dimension: Method: get
Path: /outline/{app}/{cube}/pivotDimension
Get Text Lists: Method: get
Path: /outline/{app}/{cube}/settings/smartlist

Partitions

The operations from the Partitions category.

Create Partition: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions
Delete Partition: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/partitions
Get Partition Cell Count: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions/cellcount
Get Partitions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/partitions
Get Supported Partition Types: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/partitions/supportedfederatedtypes
Lock Partition: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions/lock
Replicate Data: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions/replicatedata
Unlock Partition: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions/unlock
Update Partition: Method: patch
Path: /applications/{applicationName}/databases/{databaseName}/partitions
Validate Partition: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/partitions/validate

Performance Analyzer

The operations from the Performance Analyzer category.

Delete Performance Analyzer Files: Method: delete
Path: /performance/files
Get Performance Analyzer File: Method: get
Path: /performance/files/actions/download
Get Performance Analyzer File: Method: get
Path: /performance/files/{file}
Get Performance Analyzer Files: Method: get
Path: /performance/files
Get Performance Analyzer Settings: Method: get
Path: /performance/settings
Set Performance Analyzer Settings: Method: put
Path: /performance/settings

Platform Service Settings

The operations from the Platform Service Settings category.

Get Available Platform Service Settings: Method: get
Path: /settings
Get Diagnostic Log Settings: Method: get
Path: /settings/odlLogSettings
Get Maintenance Settings: Method: get
Path: /settings/maintenance
Set Diagnostic Log Settings: Method: put
Path: /settings/odlLogSettings

Preferences

The operations from the Preferences category.

Get User Preferences: Method: get
Path: /preferences

Properties

The operations from the Properties category.

Create Server Property: Method: post
Path: /properties
Delete Server Property: Method: delete
Path: /properties/{propertyName}
Get Server Properties: Method: get
Path: /properties
Get Server Property: Method: get
Path: /properties/{propertyName}
Update Property Values: Method: put
Path: /properties
Update Server Property: Method: put
Path: /properties/{propertyName}

ROCluster

The operations from the ROCluster category.

Change Read-only Cluster Status: Method: post
Path: /rocluster/changestatus
Create ReadOnly Cluster: Method: post
Path: /rocluster
Delete ReadOnly Cluster: Method: delete
Path: /rocluster
Find ReadOnly Cluster by Name: Method: get
Path: /rocluster/findByName
Get App Cube List: Method: get
Path: /rocluster/{svrName}/appcubelist
Get Read-only Cluster List: Method: get
Path: /rocluster
Update ReadOnly Cluster: Method: put
Path: /rocluster

Roles

The operations from the Roles category.

Get Essbase Roles: Method: get
Path: /roles

Rules

The operations from the Rules category.

Create Rules: Method: post
Path: /utils/rules
Get Rules: Method: get
Path: /utils/rules
Import Rules: Method: post
Path: /utils/rules/actions/import
Preview Rules Data: Method: post
Path: /utils/rules/preview
Verify Rule: Method: post
Path: /utils/rules/verifyRule
Verify Rule Deprecated: Method: post
Path: /utils/rules/verify

Sandbox Dimension

The operations from the Sandbox Dimension category.

Add Sandbox Members: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/sandbox/members
Create Sandbox: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/sandbox
Delete Sandbox: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/sandbox
Get Sandbox Details: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/sandbox

Scenarios

The operations from the Scenarios category.

Add Approver: Method: post
Path: /scenarios/{scenarioId}/approvers
Add Comment: Method: post
Path: /scenarios/{scenarioId}/comments
Add Participant: Method: post
Path: /scenarios/{scenarioId}/participants
Create Scenario: Method: post
Path: /scenarios
Delete Approver: Method: delete
Path: /scenarios/{scenarioId}/approvers/{userId}
Delete Comment: Method: delete
Path: /scenarios/{scenarioId}/comments/{commentId}
Delete Participant: Method: delete
Path: /scenarios/{scenarioId}/participants/{userId}
Delete Scenario: Method: delete
Path: /scenarios/{id}
Get Approvers: Method: get
Path: /scenarios/{scenarioId}/approvers
Get Changes: Method: get
Path: /scenarios/{id}/changes
Get Comment: Method: get
Path: /scenarios/{scenarioId}/comments/{commentId}
Get Comments: Method: get
Path: /scenarios/{scenarioId}/comments
Get Participants: Method: get
Path: /scenarios/{scenarioId}/participants
Get Scenario: Method: get
Path: /scenarios/{id}
Get Scenario Enabled Cubes: Method: get
Path: /scenarios/databases
Get Scenario Scripts: Method: get
Path: /scenarios/{scenarioId}/scripts
Get Scenarios: Method: get
Path: /scenarios
Perform Scenario Action: Method: post
Path: /scenarios/{id}
Update Comment: Method: put
Path: /scenarios/{scenarioId}/comments/{commentId}
Update Scenario Fully: Method: put
Path: /scenarios/{id}
Update Scenario Partially: Method: patch
Path: /scenarios/{id}
Update Scenario with Script: Method: put
Path: /scenarios/{scenarioId}/scripts/{scriptType}

Scripts

The operations from the Scripts category.

Add Calc Script Permissions: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions
Copy Calc Script: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts/scriptops/copy
Create Essbase Script: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts
Delete Calc or MDX Script: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
Get Calc or MDX Script: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
Get Essbase Script Contents: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/content
Get Essbase Script Permissions: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions
Get Essbase Script RTSVs: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/rtsv
List Calc or MDX Scripts: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/scripts
Remove Calc Script Permissions: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/permissions/{userGroupId}
Rename Calc Script: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts/scriptops/rename
Update Essbase Script: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
Upload Script Content: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/content
Validate Calc Script: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts/scriptops/validate
Validate Calc Script: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}/scriptops/validate

Server Variables

The operations from the Server Variables category.

Create Server Variable: Method: post
Path: /variables
Delete Server Variable: Method: delete
Path: /variables/{variableName}
Get Server Variable: Method: get
Path: /variables/{variableName}
Get Server Variables: Method: get
Path: /variables
Update Server Variable: Method: put
Path: /variables/{variableName}

Server logs

The operations from the Server logs category.

Download All Logs: Method: get
Path: /logs/{serverType}/all
Download Latest Log: Method: get
Path: /logs/{serverType}/latest
Download Logs for Server Type: Method: get
Path: /logs/{serverType}
Get All Server Types: Method: get
Path: /logs
Return Filtered Logs: Method: get
Path: /logs/stream

Service Role Provisioning

The operations from the Service Role Provisioning category.

Deprovision Service Role: Method: delete
Path: /permissions/{id}
Get Service Role Provisioning: Method: get
Path: /permissions/{id}
Provision Service Role: Method: put
Path: /permissions/{id}
Search Service Role Provisioning: Method: get
Path: /permissions

Sessions

The operations from the Sessions category.

Delete All Sessions: Method: delete
Path: /sessions
Delete Session By ID: Method: delete
Path: /sessions/{sessionId}
List Sessions: Method: get
Path: /sessions

Streaming Data Load

The operations from the Streaming Data Load category.

End Data Load: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/dataload/{streamId}
Push Data: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dataload/{streamId}
Start Data Load: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dataload

Streaming Dimension Build

The operations from the Streaming Dimension Build category.

End Dimension Build: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}/{ruleFileName}
End Streaming Dimension Build: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}
Push Dimensions: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}
Start Dimension Build: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dimbuild/{streamId}/{ruleFileName}
Start Streaming Dimension Build: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/dimbuild

Templates and Utilities

The operations from the Templates and Utilities category.

Download Utility: Method: get
Path: /utilities/{id}
List Utilities: Method: get
Path: /utilities

URLs

The operations from the URLs category.

Get Essbase URLs: Method: get
Path: /urls

User Provisioning Report

The operations from the User Provisioning Report category.

Get User's Applications Provisioning Report: Method: get
Path: /users/{userId}/provisionReport/applications
Get User's Filters Provisioning Report: Method: get
Path: /users/{userId}/provisionReport/applications/{application}/filters
Get User's Full Provisioning Report: Method: get
Path: /users/{userId}/provisionReport
Get User???s Scripts Provisioning Report: Method: get
Path: /users/{userId}/provisionReport/applications/{application}/scripts
Get Users Application Provisioning Report: Method: get
Path: /users/{userId}/provisionReport/applications/{application}
Get Users Application Roles Provisioning Report: Method: get
Path: /users/{userId}/provisionReport/applications/{application}/roles

User Session

The operations from the User Session category.

Get Session: Method: get
Path: /session
Logout Session: Method: delete
Path: /session
Reset Password: Method: put
Path: /session/password

Users

The operations from the Users category.

Add or Import Users: Method: post
Path: /users
Delete User: Method: delete
Path: /users/{id}
Delete Users: Method: post
Path: /users/actions/delete
Get User: Method: get
Path: /users/{id}
Search or Export Users: Method: get
Path: /users
Update User: Method: put
Path: /users/{id}

Variables

The operations from the Variables category.

Create Application Variable: Method: post
Path: /applications/{applicationName}/variables
Create Database Variable: Method: post
Path: /applications/{applicationName}/databases/{databaseName}/variables
Delete Application Variable: Method: delete
Path: /applications/{applicationName}/variables/{variableName}
Delete Database Variable: Method: delete
Path: /applications/{applicationName}/databases/{databaseName}/variables/{variableName}
Get Application Variable: Method: get
Path: /applications/{applicationName}/variables/{variableName}
Get Application Variables: Method: get
Path: /applications/{applicationName}/variables
Get Database Variable: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/variables/{variableName}
Get Database Variables: Method: get
Path: /applications/{applicationName}/databases/{databaseName}/variables
Update Application Variable: Method: put
Path: /applications/{applicationName}/variables/{variableName}
Update Database Variable: Method: put
Path: /applications/{applicationName}/databases/{databaseName}/variables/{variableName}

Workbook Utilities

The operations from the Workbook Utilities category.

Get Workbook Format: Method: get
Path: /excel/utils/dataformat