Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use cURL
• Authenticate
• Send Requests
• Status Codes

Tasks

• About Essbase
  • About Essbase
  • About Essbase Instance
• Aggregate Storage Load Buffers
  • Create Buffer
  • Destroy Dataload Buffer
  • List Buffers
  • Merge Data
• Application Configuration
  • Add Application Configuration
  • Delete Application Configuration
  • Get Application Configuration
  • Get Application Configuration (Filtered)
  • Get Application Configuration Property
  • Update Application Configuration
  • Update Application Configurations
• Application Connections
  • Create Application Connection
  • Delete Application Connection
  • Get Application Connection
  • List Application Connections
  • Test New Application Connection
  • Test Saved Application Connection
  • Update Application Connection
  • Upload Application Connection Wallet File
• Application Datasources
  • Create Application Datasource
  • Delete Application Datasource
  • Get Application Datasource
  • Get Application Datasources
  • Get Streamed Datasource Results
  • Update Application Datasource
• Application Logs
  • Download All Application Logs
  • Download Application Logs
  • Download Latest Application Log
• Application Role Provisioning
  • Deprovision User or Group from Application
  • Get Application Role Provision
  • Import Application Role Provisioning
  • Provision Application Role to User or Group
  • Search Application Role Provisioning
• Application Settings and Statistics
  • Get Application General Settings
  • Get Application Security Settings
  • Get Application Startup Settings
  • Get Application Statistics
  • Update Application Settings
• Applications
  • Copy Application
  • Copy Database
  • Create Application and Database
  • Create Shadow Application
  • Decrypt Application
  • Delete Application
  • Delete Database
  • Delete Shadow Application
  • Encrypt Application
  • Execute Report Script
  • Get Application
  • Get Application Provisioning Report
  • Get Application Tree View
  • Get Calculation Functions
  • Get Currency Settings
  • Get Database
  • Get Encryption Info
  • Get Formula Functions
  • Get MDX Functions
  • List Active Aliases
  • List Aliases
  • List Application Names
  • List Applications
  • List Databases
  • Promote Shadow Application
  • Rename Application
  • Rename Database
  • Set Currency Settings
  • Start or Stop Application
  • Start or Stop Database
• Audit Trail
  • Delete Audit Data
  • Get Audit Data
• Batch Outline Editing
  • Run Batch Outline Edit
• Database Settings and Statistics
  • Export Query Tracking
  • Get ASO Compression Info
  • Get Attribute Settings
  • Get Buffer Settings
  • Get Cache Settings
  • Get Calculation Settings
  • Get Compression Settings
  • Get Date Formats
  • Get General Settings
  • Get General Statistics
  • Get Outline Settings
  • Get Runtime Statistics
  • Get Startup Settings
  • Get Storage Statistics
  • Get Transaction Settings
  • Import Query Tracking
  • Update Outline Settings
  • Update Settings
• Database Size Statistics
  • Get Database Size Statistics
• Dimensions
  • Get Generation
  • Get Level
  • List Dimensions
  • List Generations
  • List Levels
  • Update Generation
  • Update Level
• Drill Through Reports
  • Create Drill Through Report
  • Delete Drill Through Report
  • Execute Drill Through Report
  • Get Drill Through Report
  • Get Drill Through Reports
  • Update Drill Through Report
• Email
  • Add IMAP Configuration
  • Add SMTP Configuration
  • Delete IMAP Configuration
  • Delete SMTP Configuration
  • Get E-mail Configuration
  • Get IMAP Configuration
  • Get SMTP Configuration
• Execute MDX
  • Run MDX Query
  • Run MDX Report
• File Scanner
  • Delete Antivirus
  • Get Antivirus
  • Set Antivirus
  • Validate Antivirus
• Files
  • Abort Multipart File Upload
  • Commit Multipart File Upload
  • Copy File
  • Create Multipart File Upload
  • Delete File or Folder
  • Extract Zip File
  • Extract Zip File Using a Job
  • Get Home Path
  • Get Shared Path
  • List or Download Files
  • List Root Folders
  • Move or Rename File
  • Upload File or Create Folder
  • Upload File Part
• Filters
  • Add Permissions in Filter
  • Copy Filter
  • Create Filter
  • Delete Filter
  • Delete Permission from Filter
  • Get Filter
  • Get Filter Rows
  • Get Filters
  • Get Permissions
  • Rename Filter
  • Replace Filter Permissions
  • Update Filter
  • Validate Filter
• Global Connections
  • Create Global Connection
  • Delete Global Connection
  • Get Global Connection
  • List Global Connections
  • Test New Global Connection
  • Test Saved Global Connection
  • Update Global Connection
  • Upload Global Connection Wallet File
• Global Datasources
  • Create Global Datasource
  • Delete Global Datasource
  • Get Global Datasource
  • Get Global Datasources
  • Get Streamed Global Datasource Results
  • Get Streamed Global Datasource Results by ID
  • Stream Global Datasource Results
  • Update Global Datasource
• Grid
  • Execute Grid Layout
  • Execute Grid Operation
  • Execute MDX Report
  • Get Default Grid
  • Get Layout Grid
• Grid Preferences
  • Get Grid Preferences
  • Set Grid Preferences
• Group Provisioning Report
  • Get All Applications Provisioning Report
  • Get Application Provisioning Report
  • Get Application Roles Provisioning Report
  • Get Filters Provisioning Report
  • Get Full Provisioning Report
  • Get Scripts Provisioning Report
• Groups
  • Add Group Users
  • Add Groups to Group
  • Add or Import Group(s)
  • Delete Group
  • Delete Groups in File
  • Get Group
  • Get Group Members
  • Get Group Users
  • Get Groups in Group
  • Remove Group Users
  • Remove Groups From Group
  • Search or Export Groups
  • Update Group
• Jobs
  • Delete Jobs
  • Execute Job
  • Get Job
  • Get Job List
  • Get Job Statistics
  • Rerun Job
• Layouts
  • Delete Grid Layout
  • Get Grid Layout Details
  • List Grid Layouts
  • Mark Grid Layout as Default
  • Save Grid Layout
  • Update Grid Layout
• Location Aliases
  • Create Location Alias
  • Delete Location Alias
  • Get Location Alias
  • Get Location Aliases
  • Update Location Alias
• Locks
  • List Locked Blocks
  • List Locked Objects
  • List Locks
  • Lock Object
  • Unlock Block
  • Unlock Object
• MDX Reports
  • Delete MDX Report
  • Get MDX Report Details
  • List MDX Reports
  • Save MDX Report
  • Update MDX Report
• Outline Viewer
  • Get Descendants Count
  • Get Dimensions, Children, or Search
  • Get Member Ancestors
  • Get Member Info
  • Get Text Lists
• Partitions
  • Create Partition
  • Delete Partition
  • Get Partition Cell Count
  • Get Partitions
  • Get Supported Partition Types
  • Lock Partition
  • Replicate Data
  • Unlock Partition
  • Update Partition
  • Validate Partition
• Performance Analyzer
  • Delete Performance Analyzer Files
  • Get Performance Analyzer File
  • Get Performance Analyzer File
  • Get Performance Analyzer Files
  • Get Performance Analyzer Settings
  • Set Performance Analyzer Settings
• Platform Service Settings
  • Get Available Platform Service Settings
  • Get Database Settings
  • Get Diagnostic Log Settings
  • Get Maintenance Settings
  • Set Diagnostic Log Settings
  • Store Database Settings
• Preferences
  • Get User Preferences
• Properties
  • Create Server Property
  • Delete Server Property
  • Get Server Properties
  • Get Server Property
  • Update Property Values
  • Update Server Property
• Roles
  • Get Essbase Roles
• Rules
  • Create Rule
  • Get or Export Rule
  • Import Rule
  • Preview Rules Data
  • Verify Rule
  • Verify Rule (Deprecated)
• Sandbox Dimension
  • Add Sandbox Members
  • Create Sandbox
  • Delete Sandbox
  • Get Sandbox Details
• Scenarios
  • Add Approver
  • Add Comment
  • Add Participant
  • Create Scenario
  • Delete Approver
  • Delete Comment
  • Delete Participant
  • Delete Scenario
  • Get Approvers
  • Get Changes
  • Get Comment
  • Get Comments
  • Get Participants
  • Get Scenario
  • Get Scenario Scripts
  • Get Scenario-Enabled Cubes
  • Get Scenarios
  • Perform Scenario Action
  • Update Comment
  • Update Scenario Fully
  • Update Scenario Partially
  • Update Scenario with Script
• Scripts
  • Add Calc Script Permissions
  • Copy Calc Script
  • Create Essbase Script
  • Delete Calc or MDX Script
  • Get Calc or MDX Script
  • Get Essbase Script Contents
  • Get Essbase Script Permissions
  • Get Essbase Script RTSVs
  • List Scripts
  • Remove Calc Script Permissions
  • Rename Calc Script
  • Update Essbase Script
  • Validate Calc Script
• Server Variables
  • Create Server Variable
  • Delete Server Variable
  • Get Server Variable
  • Get Server Variables
  • Update Server Variable
• Service Role Provisioning
  • Deprovision Service Role
  • Get Service Role Provision
  • Provision Service Role
  • Search Service Role Provisioning
• Sessions
  • Delete All Sessions
  • Delete Session By ID
  • List Sessions
• Streaming Data Load
  • End Data Load
  • Push Data
  • Start Data Load
• Streaming Dimension Build
  • End Dimension Build
  • End Streaming Dimension Build
  • Push Dimensions
  • Start Dimension Build
  • Start Streaming Dimension Build
• Templates and Utilities
  • Download Utility
  • List Utilities
• URLs
  • Get Essbase URLs
• User Provisioning Report
  • Get User's Application Provisioning Report
  • Get User's Application Roles Provisioning Report
  • Get User's Applications Provisioning Reports
  • Get User's Filters Provisioning Report
  • Get User's Full Provisioning Report
  • Get User's Scripts Provisioning Report
• User Session
  • Get Session
  • Logout Session
  • Reset Password
• Users
  • Add or Import User(s)
  • Delete User
  • Delete Users
  • Get User
  • Search or Export Users
  • Update User
• Variables
  • Create Application Variable
  • Create Database Variable
  • Delete Application Variable
  • Delete Database Variable
  • Get Application Variable
  • Get Application Variables
  • Get Database Variable
  • Get Database Variables
  • Update Application Variable
  • Update Database Variable
• Workbook Utilities
  • Get Workbook Format