openapi: 3.1.0
info:
title: Oracle Essbase REST API
description: >-
RESTful API for managing and interacting with Oracle Essbase applications,
databases, and performing analytical operations. Enables automation of
Essbase resource management with endpoints for applications, databases,
calculations, data loads, user management, sessions, jobs, files, scripts,
filters, partitions, connections, datasources, dimensions, outline viewer,
locks, scenarios, server properties, and more. All communication occurs
over secured HTTP.
version: 21.0.0
contact:
name: Oracle Support
url: https://support.oracle.com
license:
name: Oracle Technology Network License
url: https://www.oracle.com/legal/terms/
x-provider: oracle-essbase
servers:
- url: https://{host}:{port}/essbase/rest/v1
description: Oracle Essbase REST API server
variables:
host:
default: localhost
description: Essbase server hostname
port:
default: '9001'
description: Essbase server port
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Application Configuration
description: Manage application-level configuration settings
- name: Applications
description: Manage Essbase applications and their lifecycle
- name: Connections
description: Manage global and application-level connections
- name: Databases
description: Manage databases (cubes) within applications
- name: Dimensions
description: View dimension information, generations, and levels
- name: Files
description: Upload, download, copy, move, and delete files in the Essbase file catalog
- name: Filters
description: Manage database security filters
- name: Groups
description: Manage user groups and memberships
- name: Jobs
description: Execute and monitor asynchronous jobs such as data loads, calculations, and exports
- name: Locks
description: Manage locks on database objects and blocks
- name: Partitions
description: Manage database partitions
- name: Reports
description: MDX reports and drill-through reports
- name: Roles
description: Service and application role provisioning
- name: Scripts
description: Manage calculation and MDX scripts
- name: Server
description: Server properties, configuration, and about information
- name: Sessions
description: Manage active user sessions
- name: User Session
description: User login, logout, and password management
- name: Users
description: Create, search, update, and delete users
- name: Variables
description: Manage server-level and application-level substitution variables
paths:
/about:
get:
operationId: getAboutEssbase
summary: Oracle Essbase Get About Essbase
description: Returns general information about the Essbase instance, including version and build details.
tags:
- Server
responses:
'200':
description: Essbase instance information returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AboutInfo'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/about/instance:
get:
operationId: getAboutEssbaseInstance
summary: Oracle Essbase Get About Essbase Instance
description: Returns detailed information about the Essbase instance deployment and configuration.
tags:
- Server
responses:
'200':
description: Instance details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AboutInfo'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications:
get:
operationId: listApplications
summary: Oracle Essbase List Applications
description: >-
Returns a list of Essbase applications the authenticated user has access
to. Supports filtering, pagination, sorting, and field selection. If
application status is required in the response, limit must be 100 or
less.
tags:
- Applications
parameters:
- name: applicationNameForConnection
in: query
description: Application name for connection filtering.
schema:
type: string
- name: connectionName
in: query
description: Filter applications by connection name.
schema:
type: string
- name: fields
in: query
description: Comma-separated list of fields to return. If omitted, all fields are returned.
schema:
type: string
- name: filter
in: query
description: Wildcard filter for application names.
schema:
type: string
default: '*'
- name: limit
in: query
description: Maximum number of applications to return. Must be 100 or less if status is included.
schema:
type: integer
format: int32
default: 50
- name: offset
in: query
description: Number of applications to skip from the start of the result set.
schema:
type: integer
format: int32
default: 0
- name: orderBy
in: query
description: 'Sort order in format column:direction (e.g., name:asc).'
schema:
type: string
responses:
'200':
description: List of applications returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationList'
'400':
description: Failed to get applications.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: createApplication
summary: Oracle Essbase Create Application and Database
description: >-
Creates a new Essbase application and optionally a database within it.
Application names are limited to 30 characters, must not contain spaces,
and are case-insensitive. Specify BSO (block storage) or ASO (aggregate
storage) for the database type.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateApplication'
responses:
'200':
description: Application created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to create application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}:
get:
operationId: getApplication
summary: Oracle Essbase Get Application
description: Returns details of the specified Essbase application, including status, type, owner, and configuration.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Application details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to get application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
operationId: startStopApplication
summary: Oracle Essbase Start or Stop Application
description: Starts or stops an Essbase application by updating its status.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Desired application status.
enum:
- started
- stopped
responses:
'200':
description: Application status updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to update application status.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteApplication
summary: Oracle Essbase Delete Application
description: Deletes the specified Essbase application and all of its databases and associated resources.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Application deleted successfully.
'400':
description: Failed to delete application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/copy:
post:
operationId: copyApplication
summary: Oracle Essbase Copy Application
description: Creates a copy of an existing Essbase application with a new name.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- from
- to
properties:
from:
type: string
description: Source application name.
to:
type: string
description: Destination application name.
responses:
'200':
description: Application copied successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to copy application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/rename:
post:
operationId: renameApplication
summary: Oracle Essbase Rename Application
description: Renames an existing Essbase application.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- from
- to
properties:
from:
type: string
description: Current application name.
to:
type: string
description: New application name.
responses:
'200':
description: Application renamed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to rename application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/tree:
get:
operationId: getApplicationTreeView
summary: Oracle Essbase Get Application Tree View
description: Returns a hierarchical tree view of applications and their databases.
tags:
- Applications
responses:
'200':
description: Application tree view returned successfully.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/name/{appVisibility}:
get:
operationId: listApplicationNames
summary: Oracle Essbase List Application Names
description: Returns a list of application names filtered by visibility.
tags:
- Applications
parameters:
- name: appVisibility
in: path
required: true
description: Application visibility filter.
schema:
type: string
responses:
'200':
description: Application names returned successfully.
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/encrypt:
post:
operationId: encryptApplication
summary: Oracle Essbase Encrypt Application
description: Encrypts the specified Essbase application for data security.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Application encrypted successfully.
'400':
description: Failed to encrypt application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/decrypt:
post:
operationId: decryptApplication
summary: Oracle Essbase Decrypt Application
description: Decrypts the specified Essbase application.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Application decrypted successfully.
'400':
description: Failed to decrypt application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/encryptionconfig:
get:
operationId: getEncryptionInfo
summary: Oracle Essbase Get Encryption Info
description: Returns encryption configuration information for the specified application.
tags:
- Applications
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Encryption info returned successfully.
content:
application/json:
schema:
type: object
properties:
encrypted:
type: boolean
description: Whether the application is encrypted.
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/provisionReport:
get:
operationId: getApplicationProvisioningReport
summary: Oracle Essbase Get Application Provisioning Report
description: Returns the provisioning report for the specified application, detailing user roles and permissions.
tags:
- Roles
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Provisioning report returned successfully.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/shadowCopy:
post:
operationId: createShadowApplication
summary: Oracle Essbase Create Shadow Application
description: Creates a shadow copy of an existing application for safe editing without affecting the production application.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- applicationName
properties:
applicationName:
type: string
description: Name of the source application to shadow.
responses:
'200':
description: Shadow application created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
'400':
description: Failed to create shadow application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/shadowPromote:
post:
operationId: promoteShadowApplication
summary: Oracle Essbase Promote Shadow Application
description: Promotes a shadow application to replace the original production application.
tags:
- Applications
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- shadowAppName
properties:
shadowAppName:
type: string
description: Name of the shadow application to promote.
responses:
'200':
description: Shadow application promoted successfully.
'400':
description: Failed to promote shadow application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/actions/shadowDelete/{shadowAppName}:
delete:
operationId: deleteShadowApplication
summary: Oracle Essbase Delete Shadow Application
description: Deletes the specified shadow application.
tags:
- Applications
parameters:
- name: shadowAppName
in: path
required: true
description: Name of the shadow application to delete.
schema:
type: string
responses:
'200':
description: Shadow application deleted successfully.
'400':
description: Failed to delete shadow application.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases:
get:
operationId: listDatabases
summary: Oracle Essbase List Databases
description: Returns a list of databases (cubes) within the specified application.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
responses:
'200':
description: Database list returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseList'
'400':
description: Failed to list databases.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/{databaseName}:
get:
operationId: getDatabase
summary: Oracle Essbase Get Database
description: Returns details of the specified database (cube) including name, status, type, owner, creation time, and settings.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
responses:
'200':
description: Database details returned successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
'400':
description: Failed to get database.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
put:
operationId: startStopDatabase
summary: Oracle Essbase Start or Stop Database
description: Starts or stops the specified database by updating its status.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Desired database status.
enum:
- started
- stopped
responses:
'200':
description: Database status updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
'400':
description: Failed to update database status.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: deleteDatabase
summary: Oracle Essbase Delete Database
description: Deletes the specified database (cube) from the application.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
responses:
'200':
description: Database deleted successfully.
'400':
description: Failed to delete database.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/actions/copy:
post:
operationId: copyDatabase
summary: Oracle Essbase Copy Database
description: Creates a copy of an existing database within the same application or to a different application.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- from
- to
properties:
from:
type: string
description: Source database name.
to:
type: string
description: Destination database name.
responses:
'200':
description: Database copied successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
'400':
description: Failed to copy database.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/actions/rename:
post:
operationId: renameDatabase
summary: Oracle Essbase Rename Database
description: Renames an existing database within the application.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- from
- to
properties:
from:
type: string
description: Current database name.
to:
type: string
description: New database name.
responses:
'200':
description: Database renamed successfully.
'400':
description: Failed to rename database.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/{databaseName}/aliases:
get:
operationId: listAliases
summary: Oracle Essbase List Aliases
description: Returns a list of alias tables defined for the specified database.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
responses:
'200':
description: Alias list returned successfully.
content:
application/json:
schema:
type: array
items:
type: string
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias:
get:
operationId: getActiveAlias
summary: Oracle Essbase Get Active Alias
description: Returns the currently active alias table for the specified database.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
responses:
'200':
description: Active alias returned successfully.
content:
application/json:
schema:
type: object
properties:
activeAlias:
type: string
description: Name of the active alias table.
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/{databaseName}/aliases/setActiveAlias:
put:
operationId: setActiveAlias
summary: Oracle Essbase Set Active Alias
description: Sets the active alias table for the specified database.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
activeAlias:
type: string
description: Name of the alias table to activate.
responses:
'200':
description: Active alias updated successfully.
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/applications/{applicationName}/databases/{databaseName}/currencySettings:
get:
operationId: getCurrencySettings
summary: Oracle Essbase Get Currency Settings
description: Returns the currency conversion settings for the specified database.
tags:
- Databases
parameters:
- $ref: '#/components/parameters/applicationName'
- $ref: '#/components/parameters/databaseName'
responses:
'200':
description: Currency settings returned successfully.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal server error.
content:
application/json:
schema:
# --- truncated at 32 KB (133 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-essbase/refs/heads/main/openapi/oracle-essbase-rest-api-openapi.yml