openapi: 3.1.0
info:
  title: Oracle Essbase REST Application Configuration Server 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: Server
  description: Server properties, configuration, and about information
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'
  /properties:
    get:
      operationId: listServerProperties
      summary: Oracle Essbase List Server Properties
      description: Returns server-level configuration properties for the Essbase instance.
      tags:
      - Server
      responses:
        '200':
          description: Server properties 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'
    put:
      operationId: updateServerProperties
      summary: Oracle Essbase Update Server Properties
      description: Updates server-level configuration properties.
      tags:
      - Server
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Server properties 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'
components:
  schemas:
    Error:
      type: object
      description: Error response from the Essbase REST API.
      properties:
        message:
          type: string
          description: Human-readable error message.
        errorCode:
          type: string
          description: Machine-readable error code.
        details:
          type: string
          description: Additional error details.
    AboutInfo:
      type: object
      description: Information about the Essbase instance.
      properties:
        version:
          type: string
          description: Essbase version number.
        build:
          type: string
          description: Build identifier.
        catalog:
          type: string
          description: Catalog information.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Essbase username and password.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 Bearer token authentication for cloud deployments on Oracle Cloud Infrastructure.