Oracle Essbase · Capability

Oracle Essbase REST API

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.

Run with Naftiko OracleEssbaseAPI

What You Can Do

GET
Getaboutessbase — Oracle Essbase Get About Essbase
/about
GET
Getaboutessbaseinstance — Oracle Essbase Get About Essbase Instance
/about/instance
GET
Listapplications — Oracle Essbase List Applications
/applications
POST
Createapplication — Oracle Essbase Create Application and Database
/applications
GET
Getapplication — Oracle Essbase Get Application
/applications/{applicationName}
PUT
Startstopapplication — Oracle Essbase Start or Stop Application
/applications/{applicationName}
DELETE
Deleteapplication — Oracle Essbase Delete Application
/applications/{applicationName}
POST
Copyapplication — Oracle Essbase Copy Application
/applications/actions/copy
POST
Renameapplication — Oracle Essbase Rename Application
/applications/actions/rename
GET
Getapplicationtreeview — Oracle Essbase Get Application Tree View
/applications/actions/tree
GET
Listapplicationnames — Oracle Essbase List Application Names
/applications/actions/name/{appVisibility}
POST
Encryptapplication — Oracle Essbase Encrypt Application
/applications/{applicationName}/encrypt
POST
Decryptapplication — Oracle Essbase Decrypt Application
/applications/{applicationName}/decrypt
GET
Getencryptioninfo — Oracle Essbase Get Encryption Info
/applications/{applicationName}/encryptionconfig
GET
Getapplicationprovisioningreport — Oracle Essbase Get Application Provisioning Report
/applications/{applicationName}/provisionReport
POST
Createshadowapplication — Oracle Essbase Create Shadow Application
/applications/actions/shadowCopy
POST
Promoteshadowapplication — Oracle Essbase Promote Shadow Application
/applications/actions/shadowPromote
DELETE
Deleteshadowapplication — Oracle Essbase Delete Shadow Application
/applications/actions/shadowDelete/{shadowAppName}
GET
Listdatabases — Oracle Essbase List Databases
/applications/{applicationName}/databases
GET
Getdatabase — Oracle Essbase Get Database
/applications/{applicationName}/databases/{databaseName}
PUT
Startstopdatabase — Oracle Essbase Start or Stop Database
/applications/{applicationName}/databases/{databaseName}
DELETE
Deletedatabase — Oracle Essbase Delete Database
/applications/{applicationName}/databases/{databaseName}
POST
Copydatabase — Oracle Essbase Copy Database
/applications/{applicationName}/databases/actions/copy
POST
Renamedatabase — Oracle Essbase Rename Database
/applications/{applicationName}/databases/actions/rename
GET
Listaliases — Oracle Essbase List Aliases
/applications/{applicationName}/databases/{databaseName}/aliases
GET
Getactivealias — Oracle Essbase Get Active Alias
/applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias
PUT
Setactivealias — Oracle Essbase Set Active Alias
/applications/{applicationName}/databases/{databaseName}/aliases/setActiveAlias
GET
Getcurrencysettings — Oracle Essbase Get Currency Settings
/applications/{applicationName}/databases/{databaseName}/currencySettings
POST
Setcurrencysettings — Oracle Essbase Set Currency Settings
/applications/{applicationName}/databases/{databaseName}/currencySettings
GET
Getcalculationfunctions — Oracle Essbase Get Calculation Functions
/applications/{applicationName}/databases/{databaseName}/calculationFunctions
GET
Getformulafunctions — Oracle Essbase Get Formula Functions
/applications/{applicationName}/databases/{databaseName}/formulaFunctions
GET
Getmdxfunctions — Oracle Essbase Get MDX Functions
/applications/{applicationName}/databases/{databaseName}/mdxFunctions
GET
Executereportscript — Oracle Essbase Execute Report Script
/applications/{applicationName}/databases/{databaseName}/executeReport
GET
Listjobs — Oracle Essbase List Jobs
/jobs
POST
Executejob — Oracle Essbase Execute Job
/jobs
GET
Getjob — Oracle Essbase Get Job
/jobs/{jobId}
DELETE
Deletejob — Oracle Essbase Delete Job Record
/jobs/{jobId}
POST
Rerunjob — Oracle Essbase Rerun Job
/jobs/{jobId}/actions/rerun
GET
Listsessions — Oracle Essbase List Sessions
/sessions
DELETE
Deletesession — Oracle Essbase Delete Session
/sessions/{sessionId}
POST
Login — Oracle Essbase Login
/session/login
POST
Logout — Oracle Essbase Logout
/session/logout
PUT
Changepassword — Oracle Essbase Change Password
/session/password
GET
Listusers — Oracle Essbase List Users
/users
POST
Createuser — Oracle Essbase Create User
/users
GET
Getuser — Oracle Essbase Get User
/users/{userId}
PUT
Updateuser — Oracle Essbase Update User
/users/{userId}
DELETE
Deleteuser — Oracle Essbase Delete User
/users/{userId}
GET
Listgroups — Oracle Essbase List Groups
/groups
POST
Creategroup — Oracle Essbase Create Group
/groups
GET
Getgroup — Oracle Essbase Get Group
/groups/{groupId}
PUT
Updategroup — Oracle Essbase Update Group
/groups/{groupId}
DELETE
Deletegroup — Oracle Essbase Delete Group
/groups/{groupId}
GET
Listgroupmembers — Oracle Essbase List Group Members
/groups/{groupId}/members
GET
Listscripts — Oracle Essbase List Scripts
/applications/{applicationName}/databases/{databaseName}/scripts
POST
Createscript — Oracle Essbase Create Script
/applications/{applicationName}/databases/{databaseName}/scripts
GET
Getscript — Oracle Essbase Get Script
/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
PUT
Updatescript — Oracle Essbase Update Script
/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
DELETE
Deletescript — Oracle Essbase Delete Script
/applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
GET
Listrootfolders — Oracle Essbase List Root Folders
/files

MCP Tools

getaboutessbase

Oracle Essbase Get About Essbase

read-only idempotent
getaboutessbaseinstance

Oracle Essbase Get About Essbase Instance

read-only idempotent
listapplications

Oracle Essbase List Applications

read-only idempotent
createapplication

Oracle Essbase Create Application and Database

getapplication

Oracle Essbase Get Application

read-only idempotent
startstopapplication

Oracle Essbase Start or Stop Application

idempotent
deleteapplication

Oracle Essbase Delete Application

idempotent
copyapplication

Oracle Essbase Copy Application

renameapplication

Oracle Essbase Rename Application

getapplicationtreeview

Oracle Essbase Get Application Tree View

read-only idempotent
listapplicationnames

Oracle Essbase List Application Names

read-only idempotent
encryptapplication

Oracle Essbase Encrypt Application

decryptapplication

Oracle Essbase Decrypt Application

getencryptioninfo

Oracle Essbase Get Encryption Info

read-only idempotent
getapplicationprovisioningreport

Oracle Essbase Get Application Provisioning Report

read-only idempotent
createshadowapplication

Oracle Essbase Create Shadow Application

promoteshadowapplication

Oracle Essbase Promote Shadow Application

deleteshadowapplication

Oracle Essbase Delete Shadow Application

idempotent
listdatabases

Oracle Essbase List Databases

read-only idempotent
getdatabase

Oracle Essbase Get Database

read-only idempotent
startstopdatabase

Oracle Essbase Start or Stop Database

idempotent
deletedatabase

Oracle Essbase Delete Database

idempotent
copydatabase

Oracle Essbase Copy Database

renamedatabase

Oracle Essbase Rename Database

listaliases

Oracle Essbase List Aliases

read-only idempotent
getactivealias

Oracle Essbase Get Active Alias

read-only idempotent
setactivealias

Oracle Essbase Set Active Alias

idempotent
getcurrencysettings

Oracle Essbase Get Currency Settings

read-only idempotent
setcurrencysettings

Oracle Essbase Set Currency Settings

getcalculationfunctions

Oracle Essbase Get Calculation Functions

read-only idempotent
getformulafunctions

Oracle Essbase Get Formula Functions

read-only idempotent
getmdxfunctions

Oracle Essbase Get MDX Functions

read-only idempotent
executereportscript

Oracle Essbase Execute Report Script

read-only idempotent
listjobs

Oracle Essbase List Jobs

read-only idempotent
executejob

Oracle Essbase Execute Job

getjob

Oracle Essbase Get Job

read-only idempotent
deletejob

Oracle Essbase Delete Job Record

idempotent
rerunjob

Oracle Essbase Rerun Job

listsessions

Oracle Essbase List Sessions

read-only idempotent
deletesession

Oracle Essbase Delete Session

idempotent
login

Oracle Essbase Login

logout

Oracle Essbase Logout

changepassword

Oracle Essbase Change Password

idempotent
listusers

Oracle Essbase List Users

read-only idempotent
createuser

Oracle Essbase Create User

getuser

Oracle Essbase Get User

read-only idempotent
updateuser

Oracle Essbase Update User

idempotent
deleteuser

Oracle Essbase Delete User

idempotent
listgroups

Oracle Essbase List Groups

read-only idempotent
creategroup

Oracle Essbase Create Group

getgroup

Oracle Essbase Get Group

read-only idempotent
updategroup

Oracle Essbase Update Group

idempotent
deletegroup

Oracle Essbase Delete Group

idempotent
listgroupmembers

Oracle Essbase List Group Members

read-only idempotent
listscripts

Oracle Essbase List Scripts

read-only idempotent
createscript

Oracle Essbase Create Script

getscript

Oracle Essbase Get Script

read-only idempotent
updatescript

Oracle Essbase Update Script

idempotent
deletescript

Oracle Essbase Delete Script

idempotent
listrootfolders

Oracle Essbase List Root Folders

read-only idempotent

Capability Spec

oracle-essbase-capability.yaml Raw ↑
naftiko: 1.0.0-alpha2
info:
  label: 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.
  tags:
  - Oracle
  - Essbase
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: oracle-essbase
    baseUri: https://localhost:9001/essbase/rest/v1
    description: Oracle Essbase REST API HTTP API.
    authentication:
      type: basic
      username: '{{ORACLE_ESSBASE_USERNAME}}'
      password: '{{ORACLE_ESSBASE_PASSWORD}}'
    resources:
    - name: about
      path: /about
      operations:
      - name: getaboutessbase
        method: GET
        description: Oracle Essbase Get About Essbase
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: about-instance
      path: /about/instance
      operations:
      - name: getaboutessbaseinstance
        method: GET
        description: Oracle Essbase Get About Essbase Instance
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications
      path: /applications
      operations:
      - name: listapplications
        method: GET
        description: Oracle Essbase List Applications
        inputParameters:
        - name: applicationNameForConnection
          in: query
          type: string
          description: Application name for connection filtering.
        - name: connectionName
          in: query
          type: string
          description: Filter applications by connection name.
        - name: fields
          in: query
          type: string
          description: Comma-separated list of fields to return. If omitted, all fields are returned.
        - name: filter
          in: query
          type: string
          description: Wildcard filter for application names.
        - name: limit
          in: query
          type: integer
          description: Maximum number of applications to return. Must be 100 or less if status is included.
        - name: offset
          in: query
          type: integer
          description: Number of applications to skip from the start of the result set.
        - name: orderBy
          in: query
          type: string
          description: Sort order in format column:direction (e.g., name:asc).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createapplication
        method: POST
        description: Oracle Essbase Create Application and Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname
      path: /applications/{applicationName}
      operations:
      - name: getapplication
        method: GET
        description: Oracle Essbase Get Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: startstopapplication
        method: PUT
        description: Oracle Essbase Start or Stop Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteapplication
        method: DELETE
        description: Oracle Essbase Delete Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-copy
      path: /applications/actions/copy
      operations:
      - name: copyapplication
        method: POST
        description: Oracle Essbase Copy Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-rename
      path: /applications/actions/rename
      operations:
      - name: renameapplication
        method: POST
        description: Oracle Essbase Rename Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-tree
      path: /applications/actions/tree
      operations:
      - name: getapplicationtreeview
        method: GET
        description: Oracle Essbase Get Application Tree View
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-name-appvisibility
      path: /applications/actions/name/{appVisibility}
      operations:
      - name: listapplicationnames
        method: GET
        description: Oracle Essbase List Application Names
        inputParameters:
        - name: appVisibility
          in: path
          type: string
          required: true
          description: Application visibility filter.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-encrypt
      path: /applications/{applicationName}/encrypt
      operations:
      - name: encryptapplication
        method: POST
        description: Oracle Essbase Encrypt Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-decrypt
      path: /applications/{applicationName}/decrypt
      operations:
      - name: decryptapplication
        method: POST
        description: Oracle Essbase Decrypt Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-encryptionconfig
      path: /applications/{applicationName}/encryptionconfig
      operations:
      - name: getencryptioninfo
        method: GET
        description: Oracle Essbase Get Encryption Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-provisionreport
      path: /applications/{applicationName}/provisionReport
      operations:
      - name: getapplicationprovisioningreport
        method: GET
        description: Oracle Essbase Get Application Provisioning Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-shadowcopy
      path: /applications/actions/shadowCopy
      operations:
      - name: createshadowapplication
        method: POST
        description: Oracle Essbase Create Shadow Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-shadowpromote
      path: /applications/actions/shadowPromote
      operations:
      - name: promoteshadowapplication
        method: POST
        description: Oracle Essbase Promote Shadow Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-actions-shadowdelete-shadowappname
      path: /applications/actions/shadowDelete/{shadowAppName}
      operations:
      - name: deleteshadowapplication
        method: DELETE
        description: Oracle Essbase Delete Shadow Application
        inputParameters:
        - name: shadowAppName
          in: path
          type: string
          required: true
          description: Name of the shadow application to delete.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases
      path: /applications/{applicationName}/databases
      operations:
      - name: listdatabases
        method: GET
        description: Oracle Essbase List Databases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}
      operations:
      - name: getdatabase
        method: GET
        description: Oracle Essbase Get Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: startstopdatabase
        method: PUT
        description: Oracle Essbase Start or Stop Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedatabase
        method: DELETE
        description: Oracle Essbase Delete Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-actions-c
      path: /applications/{applicationName}/databases/actions/copy
      operations:
      - name: copydatabase
        method: POST
        description: Oracle Essbase Copy Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-actions-r
      path: /applications/{applicationName}/databases/actions/rename
      operations:
      - name: renamedatabase
        method: POST
        description: Oracle Essbase Rename Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/aliases
      operations:
      - name: listaliases
        method: GET
        description: Oracle Essbase List Aliases
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/aliases/getActiveAlias
      operations:
      - name: getactivealias
        method: GET
        description: Oracle Essbase Get Active Alias
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/aliases/setActiveAlias
      operations:
      - name: setactivealias
        method: PUT
        description: Oracle Essbase Set Active Alias
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/currencySettings
      operations:
      - name: getcurrencysettings
        method: GET
        description: Oracle Essbase Get Currency Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: setcurrencysettings
        method: POST
        description: Oracle Essbase Set Currency Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/calculationFunctions
      operations:
      - name: getcalculationfunctions
        method: GET
        description: Oracle Essbase Get Calculation Functions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/formulaFunctions
      operations:
      - name: getformulafunctions
        method: GET
        description: Oracle Essbase Get Formula Functions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/mdxFunctions
      operations:
      - name: getmdxfunctions
        method: GET
        description: Oracle Essbase Get MDX Functions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/executeReport
      operations:
      - name: executereportscript
        method: GET
        description: Oracle Essbase Execute Report Script
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs
      path: /jobs
      operations:
      - name: listjobs
        method: GET
        description: Oracle Essbase List Jobs
        inputParameters:
        - name: applicationName
          in: query
          type: string
          description: Filter by application name.
        - name: databaseName
          in: query
          type: string
          description: Filter by database name.
        - name: jobtype
          in: query
          type: string
          description: Filter by job type.
        - name: limit
          in: query
          type: integer
          description: Maximum number of jobs to return.
        - name: offset
          in: query
          type: integer
          description: Number of records to skip.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: executejob
        method: POST
        description: Oracle Essbase Execute Job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-jobid
      path: /jobs/{jobId}
      operations:
      - name: getjob
        method: GET
        description: Oracle Essbase Get Job
        inputParameters:
        - name: jobId
          in: path
          type: integer
          required: true
          description: Unique job identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletejob
        method: DELETE
        description: Oracle Essbase Delete Job Record
        inputParameters:
        - name: jobId
          in: path
          type: integer
          required: true
          description: Unique job identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-jobid-actions-rerun
      path: /jobs/{jobId}/actions/rerun
      operations:
      - name: rerunjob
        method: POST
        description: Oracle Essbase Rerun Job
        inputParameters:
        - name: jobId
          in: path
          type: integer
          required: true
          description: Unique job identifier of the job to rerun.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sessions
      path: /sessions
      operations:
      - name: listsessions
        method: GET
        description: Oracle Essbase List Sessions
        inputParameters:
        - name: application
          in: query
          type: string
          description: Filter by application name.
        - name: database
          in: query
          type: string
          description: Filter by database name.
        - name: userId
          in: query
          type: string
          description: Filter by user ID. If not provided, returns all sessions.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sessions-sessionid
      path: /sessions/{sessionId}
      operations:
      - name: deletesession
        method: DELETE
        description: Oracle Essbase Delete Session
        inputParameters:
        - name: sessionId
          in: path
          type: string
          required: true
          description: Session identifier to terminate.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session-login
      path: /session/login
      operations:
      - name: login
        method: POST
        description: Oracle Essbase Login
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session-logout
      path: /session/logout
      operations:
      - name: logout
        method: POST
        description: Oracle Essbase Logout
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session-password
      path: /session/password
      operations:
      - name: changepassword
        method: PUT
        description: Oracle Essbase Change Password
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: Oracle Essbase List Users
        inputParameters:
        - name: expand
          in: query
          type: string
          description: Include service role and groups. Values are all or none.
        - name: filter
          in: query
          type: string
          description: User ID wildcard pattern for filtering.
        - name: limit
          in: query
          type: integer
          description: Maximum number of users to return. -1 for no limit.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Oracle Essbase Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userid
      path: /users/{userId}
      operations:
      - name: getuser
        method: GET
        description: Oracle Essbase Get User
        inputParameters:
        - name: userId
          in: path
          type: string
          required: true
          description: User identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Oracle Essbase Update User
        inputParameters:
        - name: userId
          in: path
          type: string
          required: true
          description: User identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteuser
        method: DELETE
        description: Oracle Essbase Delete User
        inputParameters:
        - name: userId
          in: path
          type: string
          required: true
          description: User identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups
      path: /groups
      operations:
      - name: listgroups
        method: GET
        description: Oracle Essbase List Groups
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Group name wildcard pattern for filtering.
        - name: limit
          in: query
          type: integer
          description: Maximum number of groups to return.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: creategroup
        method: POST
        description: Oracle Essbase Create Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid
      path: /groups/{groupId}
      operations:
      - name: getgroup
        method: GET
        description: Oracle Essbase Get Group
        inputParameters:
        - name: groupId
          in: path
          type: string
          required: true
          description: Group identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updategroup
        method: PUT
        description: Oracle Essbase Update Group
        inputParameters:
        - name: groupId
          in: path
          type: string
          required: true
          description: Group identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletegroup
        method: DELETE
        description: Oracle Essbase Delete Group
        inputParameters:
        - name: groupId
          in: path
          type: string
          required: true
          description: Group identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: groups-groupid-members
      path: /groups/{groupId}/members
      operations:
      - name: listgroupmembers
        method: GET
        description: Oracle Essbase List Group Members
        inputParameters:
        - name: groupId
          in: path
          type: string
          required: true
          description: Group identifier.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/scripts
      operations:
      - name: listscripts
        method: GET
        description: Oracle Essbase List Scripts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createscript
        method: POST
        description: Oracle Essbase Create Script
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: applications-applicationname-databases-databasen
      path: /applications/{applicationName}/databases/{databaseName}/scripts/{scriptName}
      operations:
      - name: getscript
        method: GET
        description: Oracle Essbase Get Script
        inputParameters:
        - name: scriptName
          in: path
          type: string
          required: true
          description: Script name.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatescript
        method: PUT
        description: Oracle Essbase Update Script
        inputParameters:
        - name: scriptName
          in: path
          type: string
          required: true
          description: Script name.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletescript
        method: DELETE
        description: Oracle Essbase Delete Script
        inputParameters:
        - name: scriptName
          in: path
          type: string
          required: true
          description: Script name.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: files
      path: /files
      operations:
      - name: listrootfolders
        method: GET
        description: Oracle Essbase List Root Folders
        inputParameters:
        - name: filter
          in: query
          type: string
          description: Filter the list of files.
        - name: recursive
          in: query
          type: boolean
          description: Return search results recursively.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    port: 8080
    namespace: oracle-essbase-rest
    description: REST adapter for Oracle Essbase REST API.
    resources:
    - path: /about
      name: getaboutessbase
      operations:
      - method: GET
        name: getaboutessbase
        description: Oracle Essbase Get About Essbase
        call: oracle-essbase.getaboutessbase
        outputParameters:
        - type: object
          mapping: $.
    - path: /about/instance
      name: getaboutessbaseinstance
      operations:
      - method: GET
        name: getaboutessbaseinstance
        description: Oracle Essbase Get About Essbase Instance
        call: oracle-essbase.getaboutessbaseinstance
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications
      name: listapplications
      operations:
      - method: GET
        name: listapplications
        description: Oracle Essbase List Applications
        call: oracle-essbase.listapplications
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications
      name: createapplication
      operations:
      - method: POST
        name: createapplication
        description: Oracle Essbase Create Application and Database
        call: oracle-essbase.createapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}
      name: getapplication
      operations:
      - method: GET
        name: getapplication
        description: Oracle Essbase Get Application
        call: oracle-essbase.getapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}
      name: startstopapplication
      operations:
      - method: PUT
        name: startstopapplication
        description: Oracle Essbase Start or Stop Application
        call: oracle-essbase.startstopapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}
      name: deleteapplication
      operations:
      - method: DELETE
        name: deleteapplication
        description: Oracle Essbase Delete Application
        call: oracle-essbase.deleteapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/copy
      name: copyapplication
      operations:
      - method: POST
        name: copyapplication
        description: Oracle Essbase Copy Application
        call: oracle-essbase.copyapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/rename
      name: renameapplication
      operations:
      - method: POST
        name: renameapplication
        description: Oracle Essbase Rename Application
        call: oracle-essbase.renameapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/tree
      name: getapplicationtreeview
      operations:
      - method: GET
        name: getapplicationtreeview
        description: Oracle Essbase Get Application Tree View
        call: oracle-essbase.getapplicationtreeview
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/name/{appVisibility}
      name: listapplicationnames
      operations:
      - method: GET
        name: listapplicationnames
        description: Oracle Essbase List Application Names
        call: oracle-essbase.listapplicationnames
        with:
          appVisibility: rest.appVisibility
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/encrypt
      name: encryptapplication
      operations:
      - method: POST
        name: encryptapplication
        description: Oracle Essbase Encrypt Application
        call: oracle-essbase.encryptapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/decrypt
      name: decryptapplication
      operations:
      - method: POST
        name: decryptapplication
        description: Oracle Essbase Decrypt Application
        call: oracle-essbase.decryptapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/encryptionconfig
      name: getencryptioninfo
      operations:
      - method: GET
        name: getencryptioninfo
        description: Oracle Essbase Get Encryption Info
        call: oracle-essbase.getencryptioninfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/provisionReport
      name: getapplicationprovisioningreport
      operations:
      - method: GET
        name: getapplicationprovisioningreport
        description: Oracle Essbase Get Application Provisioning Report
        call: oracle-essbase.getapplicationprovisioningreport
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/shadowCopy
      name: createshadowapplication
      operations:
      - method: POST
        name: createshadowapplication
        description: Oracle Essbase Create Shadow Application
        call: oracle-essbase.createshadowapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/shadowPromote
      name: promoteshadowapplication
      operations:
      - method: POST
        name: promoteshadowapplication
        description: Oracle Essbase Promote Shadow Application
        call: oracle-essbase.promoteshadowapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/actions/shadowDelete/{shadowAppName}
      name: deleteshadowapplication
      operations:
      - method: DELETE
        name: deleteshadowapplication
        description: Oracle Essbase Delete Shadow Application
        call: oracle-essbase.deleteshadowapplication
        with:
          shadowAppName: rest.shadowAppName
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/databases
      name: listdatabases
      operations:
      - method: GET
        name: listdatabases
        description: Oracle Essbase List Databases
        call: oracle-essbase.listdatabases
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/databases/{databaseName}
      name: getdatabase
      operations:
      - method: GET
        name: getdatabase
        description: Oracle Essbase Get Database
        call: oracle-essbase.getdatabase
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/databases/{databaseName}
      name: startstopdatabase
      operations:
      - method: PUT
        name: startstopdatabase
        description: Oracle Essbase Start or Stop Database
        call: oracle-essbase.startstopdatabase
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/databases/{databaseName}
      name: deletedatabase
      operations:
      - method: DELETE
        name: deletedatabase
        description: Oracle Essbase Delete Database
        call: oracle-essbase.deletedatabase
        outputParameters:
        - type: object
          mapping: $.
    - path: /applications/{applicationName}/databases/actions/copy
      name: copydatabase
      operations:
      - method: POST
        name: copydatabase
        description: Oracle Essbase Copy Database
        call: oracle-essbase.copydatabase
        outputParameters:
        - type: object
          mapping: $.
    

# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle-essbase/refs/heads/main/capabilities/oracle-essbase-capability.yaml