SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports

naftiko: 1.0.0-alpha2
info:
  label: SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports
  description: 'SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports. 3 operations. Lead operation:
    SAP Business Intelligence Get a report document. Self-contained Naftiko capability covering one Sap Bi business surface.'
  tags:
  - Sap Bi
  - Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_BI_API_KEY: SAP_BI_API_KEY
capability:
  consumes:
  - type: http
    namespace: businessobjects-platform-reports
    baseUri: https://{server}:{port}/biprws
    description: SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports business capability. Self-contained,
      no shared references.
    resources:
    - name: documents-documentId
      path: /documents/{documentId}
      operations:
      - name: getdocument
        method: GET
        description: SAP Business Intelligence Get a report document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents-documentId-dataproviders
      path: /documents/{documentId}/dataproviders
      operations:
      - name: listdataproviders
        method: GET
        description: SAP Business Intelligence List data providers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: documents-documentId-parameters
      path: /documents/{documentId}/parameters
      operations:
      - name: listdocumentparameters
        method: GET
        description: SAP Business Intelligence List report parameters
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-SAP-LogonToken
      value: '{{env.SAP_BI_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: businessobjects-platform-reports-rest
    port: 8080
    description: REST adapter for SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/documents/{documentid}
      name: documents-documentid
      description: REST surface for documents-documentId.
      operations:
      - method: GET
        name: getdocument
        description: SAP Business Intelligence Get a report document
        call: businessobjects-platform-reports.getdocument
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{documentid}/dataproviders
      name: documents-documentid-dataproviders
      description: REST surface for documents-documentId-dataproviders.
      operations:
      - method: GET
        name: listdataproviders
        description: SAP Business Intelligence List data providers
        call: businessobjects-platform-reports.listdataproviders
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/documents/{documentid}/parameters
      name: documents-documentid-parameters
      description: REST surface for documents-documentId-parameters.
      operations:
      - method: GET
        name: listdocumentparameters
        description: SAP Business Intelligence List report parameters
        call: businessobjects-platform-reports.listdocumentparameters
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: businessobjects-platform-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Business Intelligence SAP BusinessObjects BI Platform REST API — Reports. One tool per
      consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: sap-business-intelligence-get-report
      description: SAP Business Intelligence Get a report document
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: businessobjects-platform-reports.getdocument
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-business-intelligence-list-data
      description: SAP Business Intelligence List data providers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: businessobjects-platform-reports.listdataproviders
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-business-intelligence-list-report
      description: SAP Business Intelligence List report parameters
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: businessobjects-platform-reports.listdocumentparameters
      outputParameters:
      - type: object
        mapping: $.