openapi: 3.1.0
info:
  title: Oracle Essbase REST Application Configuration Partitions 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: Partitions
  description: Manage database partitions
paths:
  /applications/{applicationName}/databases/{databaseName}/partitions:
    get:
      operationId: listPartitions
      summary: Oracle Essbase List Partitions
      description: Returns a list of partitions defined for the specified database.
      tags:
      - Partitions
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      responses:
        '200':
          description: Partition list 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'
    post:
      operationId: createPartition
      summary: Oracle Essbase Create Partition
      description: Creates a new partition between databases for data federation.
      tags:
      - Partitions
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Partition created successfully.
        '400':
          description: Failed to create partition.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /applications/partitions/supportedfederatedtypes:
    get:
      operationId: getSupportedPartitionTypes
      summary: Oracle Essbase Get Supported Partition Types
      description: Returns the list of supported partition types for federated operations.
      tags:
      - Partitions
      responses:
        '200':
          description: Supported partition types returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    applicationName:
      name: applicationName
      in: path
      required: true
      description: Essbase application name.
      schema:
        type: string
    databaseName:
      name: databaseName
      in: path
      required: true
      description: Essbase database (cube) name.
      schema:
        type: string
  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.
  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.