Oracle Essbase REST API — Applications

naftiko: 1.0.0-alpha2
info:
  label: Oracle Essbase REST API — Applications
  description: 'Oracle Essbase REST API — Applications. 15 operations. Lead operation: Oracle Essbase List Applications. Self-contained
    Naftiko capability covering one Oracle Essbase business surface.'
  tags:
  - Oracle Essbase
  - Applications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_ESSBASE_API_KEY: ORACLE_ESSBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-applications
    baseUri: https://{host}:{port}/essbase/rest/v1
    description: Oracle Essbase REST API — Applications business capability. Self-contained, no shared references.
    resources:
    - name: applications
      path: /applications
      operations:
      - name: listapplications
        method: GET
        description: Oracle Essbase List Applications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        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).
      - name: createapplication
        method: POST
        description: Oracle Essbase Create Application and Database
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - 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: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: applications-actions-name-appVisibility
      path: /applications/actions/name/{appVisibility}
      operations:
      - name: listapplicationnames
        method: GET
        description: Oracle Essbase List Application Names
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: appVisibility
          in: path
          type: string
          description: Application visibility filter.
          required: true
    - 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: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - 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: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: applications-actions-shadowDelete-shadowAppName
      path: /applications/actions/shadowDelete/{shadowAppName}
      operations:
      - name: deleteshadowapplication
        method: DELETE
        description: Oracle Essbase Delete Shadow Application
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: shadowAppName
          in: path
          type: string
          description: Name of the shadow application to delete.
          required: true
    - 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: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - 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-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: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapplication
        method: DELETE
        description: Oracle Essbase Delete 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-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-encryptionconfig
      path: /applications/{applicationName}/encryptionconfig
      operations:
      - name: getencryptioninfo
        method: GET
        description: Oracle Essbase Get Encryption Info
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ORACLE_ESSBASE_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-applications-rest
    port: 8080
    description: REST adapter for Oracle Essbase REST API — Applications. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/applications
      name: applications
      description: REST surface for applications.
      operations:
      - method: GET
        name: listapplications
        description: Oracle Essbase List Applications
        call: rest-applications.listapplications
        with:
          applicationNameForConnection: rest.applicationNameForConnection
          connectionName: rest.connectionName
          fields: rest.fields
          filter: rest.filter
          limit: rest.limit
          offset: rest.offset
          orderBy: rest.orderBy
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapplication
        description: Oracle Essbase Create Application and Database
        call: rest-applications.createapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/copy
      name: applications-actions-copy
      description: REST surface for applications-actions-copy.
      operations:
      - method: POST
        name: copyapplication
        description: Oracle Essbase Copy Application
        call: rest-applications.copyapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/name/{appvisibility}
      name: applications-actions-name-appvisibility
      description: REST surface for applications-actions-name-appVisibility.
      operations:
      - method: GET
        name: listapplicationnames
        description: Oracle Essbase List Application Names
        call: rest-applications.listapplicationnames
        with:
          appVisibility: rest.appVisibility
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/rename
      name: applications-actions-rename
      description: REST surface for applications-actions-rename.
      operations:
      - method: POST
        name: renameapplication
        description: Oracle Essbase Rename Application
        call: rest-applications.renameapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/shadowcopy
      name: applications-actions-shadowcopy
      description: REST surface for applications-actions-shadowCopy.
      operations:
      - method: POST
        name: createshadowapplication
        description: Oracle Essbase Create Shadow Application
        call: rest-applications.createshadowapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/shadowdelete/{shadowappname}
      name: applications-actions-shadowdelete-shadowappname
      description: REST surface for applications-actions-shadowDelete-shadowAppName.
      operations:
      - method: DELETE
        name: deleteshadowapplication
        description: Oracle Essbase Delete Shadow Application
        call: rest-applications.deleteshadowapplication
        with:
          shadowAppName: rest.shadowAppName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/shadowpromote
      name: applications-actions-shadowpromote
      description: REST surface for applications-actions-shadowPromote.
      operations:
      - method: POST
        name: promoteshadowapplication
        description: Oracle Essbase Promote Shadow Application
        call: rest-applications.promoteshadowapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/actions/tree
      name: applications-actions-tree
      description: REST surface for applications-actions-tree.
      operations:
      - method: GET
        name: getapplicationtreeview
        description: Oracle Essbase Get Application Tree View
        call: rest-applications.getapplicationtreeview
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/{applicationname}
      name: applications-applicationname
      description: REST surface for applications-applicationName.
      operations:
      - method: GET
        name: getapplication
        description: Oracle Essbase Get Application
        call: rest-applications.getapplication
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: startstopapplication
        description: Oracle Essbase Start or Stop Application
        call: rest-applications.startstopapplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapplication
        description: Oracle Essbase Delete Application
        call: rest-applications.deleteapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/{applicationname}/decrypt
      name: applications-applicationname-decrypt
      description: REST surface for applications-applicationName-decrypt.
      operations:
      - method: POST
        name: decryptapplication
        description: Oracle Essbase Decrypt Application
        call: rest-applications.decryptapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/{applicationname}/encrypt
      name: applications-applicationname-encrypt
      description: REST surface for applications-applicationName-encrypt.
      operations:
      - method: POST
        name: encryptapplication
        description: Oracle Essbase Encrypt Application
        call: rest-applications.encryptapplication
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/applications/{applicationname}/encryptionconfig
      name: applications-applicationname-encryptionconfig
      description: REST surface for applications-applicationName-encryptionconfig.
      operations:
      - method: GET
        name: getencryptioninfo
        description: Oracle Essbase Get Encryption Info
        call: rest-applications.getencryptioninfo
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-applications-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Essbase REST API — Applications. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: oracle-essbase-list-applications
      description: Oracle Essbase List Applications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-applications.listapplications
      with:
        applicationNameForConnection: tools.applicationNameForConnection
        connectionName: tools.connectionName
        fields: tools.fields
        filter: tools.filter
        limit: tools.limit
        offset: tools.offset
        orderBy: tools.orderBy
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-create-application-and
      description: Oracle Essbase Create Application and Database
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.createapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-copy-application
      description: Oracle Essbase Copy Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.copyapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-list-application-names
      description: Oracle Essbase List Application Names
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-applications.listapplicationnames
      with:
        appVisibility: tools.appVisibility
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-rename-application
      description: Oracle Essbase Rename Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.renameapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-create-shadow-application
      description: Oracle Essbase Create Shadow Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.createshadowapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-delete-shadow-application
      description: Oracle Essbase Delete Shadow Application
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-applications.deleteshadowapplication
      with:
        shadowAppName: tools.shadowAppName
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-promote-shadow-application
      description: Oracle Essbase Promote Shadow Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.promoteshadowapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-get-application-tree
      description: Oracle Essbase Get Application Tree View
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-applications.getapplicationtreeview
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-get-application
      description: Oracle Essbase Get Application
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-applications.getapplication
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-start-stop-application
      description: Oracle Essbase Start or Stop Application
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-applications.startstopapplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-delete-application
      description: Oracle Essbase Delete Application
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-applications.deleteapplication
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-decrypt-application
      description: Oracle Essbase Decrypt Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.decryptapplication
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-encrypt-application
      description: Oracle Essbase Encrypt Application
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-applications.encryptapplication
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-get-encryption-info
      description: Oracle Essbase Get Encryption Info
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-applications.getencryptioninfo
      outputParameters:
      - type: object
        mapping: $.