SAP BI Tools Inbox API

openapi: 3.1.0
info:
  title: SAP BI Tools SAP Analytics Cloud Administration Inbox API
  description: RESTful API for SAP Analytics Cloud enabling programmatic access to system data stored on an SAP Analytics Cloud tenant. The API provides endpoints for managing stories, models, users, teams, calendars, and other resources. It supports SCIM 2.0 for user provisioning, OData for data access, and standard REST patterns for content management. Authentication uses OAuth 2.0 with SAML bearer assertion or authorization code grant flows.
  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://{tenant}.{datacenter}.sapanalytics.cloud
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: my-tenant
      description: The SAP Analytics Cloud tenant name
    datacenter:
      default: eu1
      description: The data center region (e.g., eu1, eu10, us1, us10, ap1)
security:
- oauth2: []
tags:
- name: Inbox
  description: Manage BI Inbox items including viewing received reports and scheduled instances.
paths:
  /v1/inbox:
    get:
      operationId: listInboxItems
      summary: SAP BI Tools List BI Inbox items
      description: Retrieves a list of items in the authenticated user's BI Inbox. The inbox contains reports and documents that have been sent to the user or scheduled instances that have completed.
      tags:
      - Inbox
      parameters:
      - $ref: '#/components/parameters/PageParam'
      - $ref: '#/components/parameters/PageSizeParam'
      - $ref: '#/components/parameters/AcceptHeader'
      responses:
        '200':
          description: Successfully retrieved inbox items
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoStoreCollection'
        '401':
          description: Invalid or expired logon token
components:
  schemas:
    InfoStoreCollection:
      type: object
      description: A paginated collection of InfoStore entries
      properties:
        entries:
          type: array
          description: The list of InfoStore entries in this page
          items:
            $ref: '#/components/schemas/InfoStoreEntry'
        __count:
          type: integer
          description: Total number of matching entries
    InfoStoreEntry:
      type: object
      description: Represents an object in the BI Platform CMS InfoStore repository. All managed objects including documents, folders, users, and groups are represented as InfoStore entries.
      properties:
        SI_ID:
          type: integer
          description: The unique CMS object identifier
        SI_NAME:
          type: string
          description: The display name of the object
        SI_KIND:
          type: string
          description: The object type (e.g., Webi, CrystalReport, Folder, FullClient, Publication)
        SI_DESCRIPTION:
          type: string
          description: A text description of the object
        SI_CREATION_TIME:
          type: string
          format: date-time
          description: The timestamp when the object was created
        SI_UPDATE_TS:
          type: string
          format: date-time
          description: The timestamp when the object was last updated
        SI_OWNER:
          type: string
          description: The owner of the object
        SI_PARENTID:
          type: integer
          description: The CMS ID of the parent folder
        SI_PATH:
          type: string
          description: The full path to the object in the repository
  parameters:
    PageParam:
      name: page
      in: query
      description: The page number for pagination (1-based)
      schema:
        type: integer
        default: 1
    AcceptHeader:
      name: Accept
      in: header
      description: The desired response format
      schema:
        type: string
        enum:
        - application/json
        - application/xml
        default: application/json
    PageSizeParam:
      name: pageSize
      in: query
      description: The number of items per page
      schema:
        type: integer
        default: 50
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAML bearer assertion or authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/authorize
          tokenUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud REST API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/3ccfab3348dd407db089accb66cff9a2.html