openapi: 3.1.0
info:
  title: Oracle Essbase REST Application Configuration Locks 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: Locks
  description: Manage locks on database objects and blocks
paths:
  /applications/{applicationName}/databases/{databaseName}/locks:
    get:
      operationId: listLocks
      summary: Oracle Essbase List Locks
      description: Returns a list of locks on the specified database.
      tags:
      - Locks
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      responses:
        '200':
          description: Lock list returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Lock'
        '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}/locks/{lockId}:
    delete:
      operationId: unlockObject
      summary: Oracle Essbase Unlock Object
      description: Releases the specified lock on a database object.
      tags:
      - Locks
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      - name: lockId
        in: path
        required: true
        description: Lock identifier.
        schema:
          type: string
      responses:
        '200':
          description: Lock released successfully.
        '400':
          description: Failed to release lock.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Lock:
      type: object
      description: A lock on a database object or block.
      properties:
        lockId:
          type: string
          description: Lock identifier.
        userId:
          type: string
          description: User who holds the lock.
        objectName:
          type: string
          description: Name of the locked object.
        lockType:
          type: string
          description: Type of lock.
        lockTime:
          type: integer
          format: int64
          description: Time the lock was acquired in milliseconds since epoch.
    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.
  parameters:
    databaseName:
      name: databaseName
      in: path
      required: true
      description: Essbase database (cube) name.
      schema:
        type: string
    applicationName:
      name: applicationName
      in: path
      required: true
      description: Essbase application name.
      schema:
        type: string
  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.