Oracle Essbase Filters API

openapi: 3.1.0
info:
  title: Oracle Essbase REST Application Configuration Filters 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: Filters
  description: Manage database security filters
paths:
  /applications/{applicationName}/databases/{databaseName}/filters:
    get:
      operationId: listFilters
      summary: Oracle Essbase List Filters
      description: Returns a list of security filters defined for the specified database.
      tags:
      - Filters
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      responses:
        '200':
          description: Filter list returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterList'
        '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: createFilter
      summary: Oracle Essbase Create Filter
      description: Creates a new security filter for the specified database to control member-level access.
      tags:
      - Filters
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterInput'
      responses:
        '200':
          description: Filter created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filter'
        '400':
          description: Failed to create filter.
          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}/filters/{filterName}:
    get:
      operationId: getFilter
      summary: Oracle Essbase Get Filter
      description: Returns details of the specified security filter.
      tags:
      - Filters
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      - name: filterName
        in: path
        required: true
        description: Filter name.
        schema:
          type: string
      responses:
        '200':
          description: Filter details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filter'
        '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: updateFilter
      summary: Oracle Essbase Update Filter
      description: Updates the specified security filter.
      tags:
      - Filters
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      - name: filterName
        in: path
        required: true
        description: Filter name.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FilterInput'
      responses:
        '200':
          description: Filter updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Filter'
        '400':
          description: Failed to update filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      operationId: deleteFilter
      summary: Oracle Essbase Delete Filter
      description: Deletes the specified security filter from the database.
      tags:
      - Filters
      parameters:
      - $ref: '#/components/parameters/applicationName'
      - $ref: '#/components/parameters/databaseName'
      - name: filterName
        in: path
        required: true
        description: Filter name.
        schema:
          type: string
      responses:
        '200':
          description: Filter deleted successfully.
        '400':
          description: Failed to delete filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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:
    Filter:
      type: object
      description: A security filter that controls member-level access to a database.
      properties:
        name:
          type: string
          description: Filter name.
        description:
          type: string
          description: Filter description.
        rows:
          type: array
          description: Filter row definitions specifying access levels per member combination.
          items:
            $ref: '#/components/schemas/FilterRow'
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    FilterInput:
      type: object
      description: Input for creating or updating a security filter.
      required:
      - name
      properties:
        name:
          type: string
          description: Filter name.
        description:
          type: string
          description: Filter description.
        rows:
          type: array
          items:
            $ref: '#/components/schemas/FilterRow'
    FilterRow:
      type: object
      description: A single row in a security filter defining access for a member combination.
      properties:
        access:
          type: string
          description: Access level.
          enum:
          - READ
          - WRITE
          - NONE
          - METAREAD
        member:
          type: string
          description: Member specification or combination.
    Link:
      type: object
      description: HATEOAS navigation link.
      properties:
        rel:
          type: string
          description: Link relation type.
        href:
          type: string
          format: uri
          description: Link URL.
        method:
          type: string
          description: HTTP method for this link.
        type:
          type: string
          description: Media type of the linked resource.
    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.
    FilterList:
      type: object
      description: List of filters.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Filter'
  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.