SAP Business Intelligence InfoObjects API

openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BusinessObjects BI Platform REST Info Objects 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: InfoObjects
  description: Manage BI platform content objects
paths:
  /infostore:
    get:
      operationId: listInfoObjects
      summary: SAP Business Intelligence List InfoObjects
      description: Query and retrieve InfoObjects from the BI Platform content management system using CMS queries.
      tags:
      - InfoObjects
      parameters:
      - name: query
        in: query
        description: CMS query string to filter objects
        schema:
          type: string
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of InfoObjects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoObjectCollection'
        '401':
          description: Unauthorized
  /infostore/{objectId}:
    get:
      operationId: getInfoObject
      summary: SAP Business Intelligence Get an InfoObject
      description: Retrieve details of a specific InfoObject by its ID.
      tags:
      - InfoObjects
      parameters:
      - $ref: '#/components/parameters/objectId'
      responses:
        '200':
          description: InfoObject details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoObject'
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
    put:
      operationId: updateInfoObject
      summary: SAP Business Intelligence Update an InfoObject
      description: Update properties of an existing InfoObject.
      tags:
      - InfoObjects
      parameters:
      - $ref: '#/components/parameters/objectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInfoObjectRequest'
      responses:
        '200':
          description: InfoObject updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoObject'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
    delete:
      operationId: deleteInfoObject
      summary: SAP Business Intelligence Delete an InfoObject
      description: Delete an InfoObject from the BI Platform.
      tags:
      - InfoObjects
      parameters:
      - $ref: '#/components/parameters/objectId'
      responses:
        '204':
          description: InfoObject deleted
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
  /infostore/{objectId}/children:
    get:
      operationId: listInfoObjectChildren
      summary: SAP Business Intelligence List children of an InfoObject
      description: Retrieve child objects of a folder or container InfoObject.
      tags:
      - InfoObjects
      parameters:
      - $ref: '#/components/parameters/objectId'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of child InfoObjects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoObjectCollection'
        '401':
          description: Unauthorized
        '404':
          description: Parent InfoObject not found
components:
  schemas:
    InfoObject:
      type: object
      properties:
        SI_ID:
          type: integer
          description: System identifier
        SI_CUID:
          type: string
          description: Cluster unique identifier
        SI_NAME:
          type: string
          description: Object name
        SI_DESCRIPTION:
          type: string
          description: Object description
        SI_KIND:
          type: string
          description: Object type kind
        SI_OWNER:
          type: string
          description: Object owner
        SI_CREATION_TIME:
          type: string
          format: date-time
          description: When the object was created
        SI_UPDATE_TS:
          type: string
          format: date-time
          description: When the object was last updated
        SI_PARENT_FOLDER:
          type: integer
          description: Parent folder ID
    UpdateInfoObjectRequest:
      type: object
      properties:
        SI_NAME:
          type: string
          description: Updated object name
        SI_DESCRIPTION:
          type: string
          description: Updated description
    InfoObjectCollection:
      type: object
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/InfoObject'
        totalCount:
          type: integer
          description: Total number of matching objects
  parameters:
    offsetParam:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
    objectId:
      name: objectId
      in: path
      required: true
      description: InfoObject unique identifier (CUID or SI_ID)
      schema:
        type: string
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 1000
  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