SAP Business Intelligence Instances API

openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BusinessObjects BI Platform REST Instances 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: Instances
  description: Manage scheduled report instances
paths:
  /infostore/{objectId}/schedules:
    get:
      operationId: listSchedules
      summary: SAP Business Intelligence List schedules for an object
      description: Retrieve all schedules configured for a specific InfoObject.
      tags:
      - Instances
      parameters:
      - $ref: '#/components/parameters/objectId'
      responses:
        '200':
          description: List of schedules
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleCollection'
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
    post:
      operationId: scheduleObject
      summary: SAP Business Intelligence Schedule an object
      description: Create a new schedule for a report or program object.
      tags:
      - Instances
      parameters:
      - $ref: '#/components/parameters/objectId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduleRequest'
      responses:
        '201':
          description: Schedule created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schedule'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
  /infostore/{objectId}/instances:
    get:
      operationId: listInstances
      summary: SAP Business Intelligence List instances of an object
      description: Retrieve all report instances generated from scheduling or on-demand execution.
      tags:
      - Instances
      parameters:
      - $ref: '#/components/parameters/objectId'
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of instances
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceCollection'
        '401':
          description: Unauthorized
        '404':
          description: InfoObject not found
components:
  schemas:
    Schedule:
      type: object
      properties:
        id:
          type: string
          description: Schedule unique identifier
        name:
          type: string
          description: Schedule name
        status:
          type: string
          enum:
          - Active
          - Paused
          - Completed
          description: Schedule status
        recurrenceType:
          type: string
          enum:
          - Once
          - Daily
          - Weekly
          - Monthly
          description: Recurrence pattern
        nextRunTime:
          type: string
          format: date-time
          description: Next scheduled run time
        format:
          type: string
          enum:
          - PDF
          - Excel
          - CSV
          - HTML
          description: Output format
    CreateScheduleRequest:
      type: object
      required:
      - name
      - recurrenceType
      properties:
        name:
          type: string
          description: Schedule name
        recurrenceType:
          type: string
          enum:
          - Once
          - Daily
          - Weekly
          - Monthly
          description: Recurrence pattern
        startTime:
          type: string
          format: date-time
          description: When the schedule starts
        endTime:
          type: string
          format: date-time
          description: When the schedule ends
        format:
          type: string
          enum:
          - PDF
          - Excel
          - CSV
          - HTML
          description: Output format
    InstanceCollection:
      type: object
      properties:
        instances:
          type: array
          items:
            $ref: '#/components/schemas/Instance'
        totalCount:
          type: integer
          description: Total number of instances
    Instance:
      type: object
      properties:
        id:
          type: integer
          description: Instance unique identifier
        name:
          type: string
          description: Instance title
        status:
          type: string
          enum:
          - Pending
          - Running
          - Success
          - Failed
          - Paused
          description: Execution status
        startTime:
          type: string
          format: date-time
          description: When the instance began running
        endTime:
          type: string
          format: date-time
          description: When the instance completed
        format:
          type: string
          description: Output format
    ScheduleCollection:
      type: object
      properties:
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/Schedule'
  parameters:
    offsetParam:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 1000
    objectId:
      name: objectId
      in: path
      required: true
      description: InfoObject unique identifier (CUID or SI_ID)
      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