REST API for Oracle Essbase

All REST Endpoints

About Essbase

About Essbase: Method: get
Path: /essbase/rest/v1/about
About Essbase Instance: Method: get
Path: /essbase/rest/v1/about/instance

Aggregate Storage Load Buffers

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

Application Configuration

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

Application Connections

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

Application Datasources

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

Application Logs

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

Application Role Provisioning

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

Application Settings and Statistics

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

Applications

Copy Application: Method: post
Path: /essbase/rest/v1/applications/actions/copy
Copy Database: Method: post
Path: /essbase/rest/v1/applications/{applicationName}/databases/actions/copy
Create Application: Method: post
Path: /essbase/rest/v1/applications
Create Shadow Application: Method: post
Path: /essbase/rest/v1/applications/actions/shadowCopy
Delete Application: Method: delete
Path: /essbase/rest/v1/applications/{applicationName}
Delete Database: Method: delete
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}
Delete Shadow Application: Method: delete
Path: /essbase/rest/v1/applications/actions/shadowDelete/{shadowAppName}
Execute Report Script: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/executeReport
Get Application: Method: get
Path: /essbase/rest/v1/applications/{applicationName}
Get Application Provisioning Report: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/provisionReport
Get Application Tree View: Method: get
Path: /essbase/rest/v1/applications/actions/tree
Get Calculation Functions: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/calculationFunctions
Get Currency Settings: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/currencySettings
Get Database: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}
Get Formula Functions: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/formulaFunctions
Get MDX Functions: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/mdxFunctions
List Active Aliases: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias
List Aliases: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/aliases
List Application Names: Method: get
Path: /essbase/rest/v1/applications/actions/name/{appVisiblity}
List Applications: Method: get
Path: /essbase/rest/v1/applications
List Databases: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases
Promote Shadow Application: Method: post
Path: /essbase/rest/v1/applications/actions/shadowPromote
Rename Application: Method: post
Path: /essbase/rest/v1/applications/actions/rename
Rename Database: Method: post
Path: /essbase/rest/v1/applications/{applicationName}/databases/actions/rename
Set Currency Settings: Method: post
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/currencySettings
Start or Stop Application: Method: put
Path: /essbase/rest/v1/applications/{applicationName}
Start or Stop Database: Method: put
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}

Audit Trail

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

Batch Outline Editing

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

Database Settings and Statistics

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

Database Size Statistics

Get Database Size Statistics: Method: get
Path: /essbase/rest/v1/databasesizestatistics

Dimensions

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

Drill Through Reports

Create Drill Through Report: Method: post
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports
Delete Drill Through Report: Method: delete
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}
Execute Drill Through Report: Method: post
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}
Get Drill Through Report: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}
Get Drill Through Reports: Method: get
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports
Update Drill Through Report: Method: put
Path: /essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}

Add IMAP Configuration: Method: put
Path: /essbase/rest/v1/email/imap
Add SMTP Configuration: Method: put
Path: /essbase/rest/v1/email/smtp
Delete IMAP Configuration: Method: delete
Path: /essbase/rest/v1/email/imap
Delete SMTP Configuration: Method: delete
Path: /essbase/rest/v1/email/smtp
Get E-mail Configuration: Method: get
Path: /essbase/rest/v1/email
Get IMAP Configuration: Method: get
Path: /essbase/rest/v1/email/imap
Get SMTP Configuration: Method: get
Path: /essbase/rest/v1/email/smtp

Execute MDX

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

File Scanner

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

Files

Abort Multipart File Upload: Method: delete
Path: /essbase/rest/v1/files/abort/{path}
Commit Multipart File Upload: Method: post
Path: /essbase/rest/v1/files/upload-commit/{path}
Copy File: Method: post
Path: /essbase/rest/v1/files/actions/copy
Create Multipart File Upload: Method: post
Path: /essbase/rest/v1/files/upload-create/{path}
Delete File or Folder: Method: delete
Path: /essbase/rest/v1/files/{path}
Extract Zip File: Method: post
Path: /essbase/rest/v1/files/actions/extract
Get Home Path: Method: get
Path: /essbase/rest/v1/files/homepath
Get Shared Path: Method: get
Path: /essbase/rest/v1/files/sharedpath
List or Download Files: Method: get
Path: /essbase/rest/v1/files/{path}
List Root Folders: Method: get
Path: /essbase/rest/v1/files
Move or Rename File: Method: post
Path: /essbase/rest/v1/files/actions/move
Upload File or Create Folder: Method: put
Path: /essbase/rest/v1/files/{path}
Upload File Part: Method: put
Path: /essbase/rest/v1/files/upload-part/{path}

Filters

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

Global Connections

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

Global Datasources

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

Grid

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

Grid Preferences

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

Group Provisioning Report

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

Groups

Add Group Users: Method: post
Path: /essbase/rest/v1/groups/{id}/members/users
Add Groups to Group: Method: post
Path: /essbase/rest/v1/groups/{id}/members/groups
Add or Import Group(s): Method: post
Path: /essbase/rest/v1/groups
Delete Group: Method: delete
Path: /essbase/rest/v1/groups/{id}
Delete Groups in File: Method: post
Path: /essbase/rest/v1/groups/actions/delete
Get Group: Method: get
Path: /essbase/rest/v1/groups/{id}
Get Group Members: Method: get
Path: /essbase/rest/v1/groups/{id}/members
Get Group Users: Method: get
Path: /essbase/rest/v1/groups/{id}/members/users
Get Groups in Group: Method: get
Path: /essbase/rest/v1/groups/{id}/members/groups
Remove Group Users: Method: delete
Path: /essbase/rest/v1/groups/{id}/members/users
Remove Groups From Group: Method: delete
Path: /essbase/rest/v1/groups/{id}/members/groups
Search or Export Groups: Method: get
Path: /essbase/rest/v1/groups
Update Group: Method: put
Path: /essbase/rest/v1/groups/{id}

Jobs

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

Layouts

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

Location Aliases

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

Locks

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

MDX Reports

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

Outline Viewer

Get Descendants Count: Method: get
Path: /essbase/rest/v1/outline/{app}/{cube}/descendantsCount/{memberUniqueName}
Get Dimensions, Children, or Search: Method: get
Path: /essbase/rest/v1/outline/{app}/{cube}
Get Member Ancestors: Method: get
Path: /essbase/rest/v1/outline/{app}/{cube}/ancestors/{memberUniqueName}
Get Member Info: Method: get
Path: /essbase/rest/v1/outline/{app}/{cube}/{memberUniqueName}
Get Text Lists: Method: get
Path: /essbase/rest/v1/outline/{app}/{cube}/settings/smartlist

Partitions

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

Performance Analyzer

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

Platform Service Settings

Get Available Platform Service Settings: Method: get
Path: /essbase/rest/v1/settings
Get Database Settings: Method: get
Path: /essbase/rest/v1/settings/database
Get Diagnostic Log Settings: Method: get
Path: /essbase/rest/v1/settings/odlLogSettings
Get Maintenance Settings: Method: get
Path: /essbase/rest/v1/settings/maintenance
Set Diagnostic Log Settings: Method: put
Path: /essbase/rest/v1/settings/odlLogSettings
Store Database Settings: Method: put
Path: /essbase/rest/v1/settings/database

Preferences

Get User Preferences: Method: get
Path: /essbase/rest/v1/preferences

Properties

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

Roles

Get Essbase Roles: Method: get
Path: /essbase/rest/v1/roles

Rules

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

Sandbox Dimension

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

Scenarios

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

Scripts

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

Server Variables

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

Service Role Provisioning

Deprovision: Method: delete
Path: /essbase/rest/v1/permissions/{id}
Get Provision: Method: get
Path: /essbase/rest/v1/permissions/{id}
Provision User or Group: Method: put
Path: /essbase/rest/v1/permissions/{id}
Search Provision: Method: get
Path: /essbase/rest/v1/permissions

Sessions

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

Streaming Data Load

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

Streaming Dimension Build

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

Templates and Utilities

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

URLs

Get Essbase URLs: Method: get
Path: /essbase/rest/v1/urls

User Provisioning Report

Get Application Provisioning Report: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport/applications/{application}
Get Application Roles Provisioning Report: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport/applications/{application}/roles
Get Applications Provisioning Reports: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport/applications
Get Filters Provisioning Report: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport/applications/{application}/filters
Get Full Provisioning Report: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport
Get Scripts Provisioning Report: Method: get
Path: /essbase/rest/v1/users/{userId}/provisionReport/applications/{application}/scripts

User Session

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

Users

Add or Import User(s): Method: post
Path: /essbase/rest/v1/users
Delete User: Method: delete
Path: /essbase/rest/v1/users/{id}
Delete Users: Method: post
Path: /essbase/rest/v1/users/actions/delete
Get User: Method: get
Path: /essbase/rest/v1/users/{id}
Search or Export Users: Method: get
Path: /essbase/rest/v1/users
Update User: Method: put
Path: /essbase/rest/v1/users/{id}

Variables

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

Workbook Utilities

Get Workbook Format: Method: get
Path: /essbase/rest/v1/excel/utils/dataformat