SAP Business Intelligence Reports API

Manage and schedule reports

Operations 3

GET /documents/{documentId} SAP Business Intelligence Get a report document #
GET /documents/{documentId}/parameters SAP Business Intelligence List report parameters #
GET /documents/{documentId}/dataproviders SAP Business Intelligence List data providers #

Documentation

Specifications

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/sap-bi-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sap-bi-reports-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BusinessObjects BI Platform REST Reports API
  description: RESTful web services for SAP BusinessObjects BI Platform administration, content management, scheduling, and reporting. Provides access to manage reports, users, folders, server infrastructure, and content within the BusinessObjects environment via the biprws endpoint.
  version: '1.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/en/index.html
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{server}:{port}/biprws
  description: SAP BusinessObjects BI Platform Server
  variables:
    server:
      default: localhost
      description: BI Platform server hostname
    port:
      default: '6405'
      description: BI Platform server port
security:
- logonToken: []
tags:
- name: Reports
  description: Manage and schedule reports
paths:
  /documents/{documentId}:
    get:
      operationId: getDocument
      summary: SAP Business Intelligence Get a report document
      description: Retrieve a specific report document with its metadata.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/documentId'
      responses:
        '200':
          description: Report document details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Report'
        '401':
          description: Unauthorized
        '404':
          description: Document not found
  /documents/{documentId}/parameters:
    get:
      operationId: listDocumentParameters
      summary: SAP Business Intelligence List report parameters
      description: Retrieve the prompt parameters for a report document.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/documentId'
      responses:
        '200':
          description: Report parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParameterCollection'
        '401':
          description: Unauthorized
        '404':
          description: Document not found
  /documents/{documentId}/dataproviders:
    get:
      operationId: listDataProviders
      summary: SAP Business Intelligence List data providers
      description: Retrieve data providers associated with a report document.
      tags:
      - Reports
      parameters:
      - $ref: '#/components/parameters/documentId'
      responses:
        '200':
          description: List of data providers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataProviderCollection'
        '401':
          description: Unauthorized
        '404':
          description: Document not found
components:
  schemas:
    DataProvider:
      type: object
      properties:
        id:
          type: string
          description: Data provider identifier
        name:
          type: string
          description: Data provider name
        dataSourceType:
          type: string
          description: Type of data source
        query:
          type: string
          description: Query text
    ParameterCollection:
      type: object
      properties:
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameter'
    DataProviderCollection:
      type: object
      properties:
        dataproviders:
          type: array
          items:
            $ref: '#/components/schemas/DataProvider'
    Parameter:
      type: object
      properties:
        id:
          type: string
          description: Parameter identifier
        name:
          type: string
          description: Parameter name
        type:
          type: string
          description: Parameter data type
        optional:
          type: boolean
          description: Whether the parameter is optional
        allowMultipleValues:
          type: boolean
          description: Whether multiple values can be provided
        defaultValues:
          type: array
          items:
            type: string
          description: Default parameter values
    Report:
      type: object
      properties:
        id:
          type: integer
          description: Report unique identifier
        cuid:
          type: string
          description: Cluster unique identifier
        name:
          type: string
          description: Report name
        description:
          type: string
          description: Report description
        type:
          type: string
          enum:
          - CrystalReport
          - Webi
          - Publication
          description: Report type
        owner:
          type: string
          description: Report owner
        createdTime:
          type: string
          format: date-time
          description: When the report was created
        modifiedTime:
          type: string
          format: date-time
          description: When the report was last modified
        folderId:
          type: integer
          description: Parent folder ID
  parameters:
    documentId:
      name: documentId
      in: path
      required: true
      description: Report document unique identifier
      schema:
        type: string
  securitySchemes:
    logonToken:
      type: apiKey
      in: header
      name: X-SAP-LogonToken
      description: SAP BusinessObjects logon token obtained from the logon endpoint
externalDocs:
  description: SAP BusinessObjects BI Platform REST API Documentation
  url: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM