SAP BI Tools Scheduling API

openapi: 3.2.0
info:
  title: SAP BI Tools SAP BusinessObjects BI Platform RESTful Web Services Scheduling API
  description: REST API for SAP BusinessObjects BI Platform (biprws) for managing documents, users, scheduling reports, and querying the CMS repository. The API provides endpoints for authentication via logon tokens, browsing the InfoStore repository, managing BI Inbox items, scheduling report execution, and performing CMS queries. Supports both JSON and XML response formats. Requires a logon token obtained through the logon endpoint for subsequent API calls.
  version: '4.3'
  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: http://{server}:{port}/biprws
  description: SAP BusinessObjects BI Platform Server
  variables:
    server:
      default: localhost
      description: The BI Platform server hostname
    port:
      default: '6405'
      description: The WACS port number
security:
- logonToken: []
tags:
- name: Scheduling
  description: Schedule reports and documents for execution with configurable parameters, recurrence, and destination options.
paths:
  /v1/infostore/{documentId}/scheduleForms/now:
    post:
      operationId: scheduleDocumentNow
      summary: SAP BI Tools Schedule a document for immediate execution
      description: Schedules a document for immediate execution on the BI Platform. Creates a new scheduled instance that runs the document with the specified parameters and delivers the output to the configured destination.
      tags:
      - Scheduling
      parameters:
      - name: documentId
        in: path
        required: true
        description: The CMS ID of the document to schedule
        schema:
          type: string
      - $ref: '#/components/parameters/AcceptHeader'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleRequest'
      responses:
        '200':
          description: Document scheduled successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleResponse'
        '401':
          description: Invalid or expired logon token
        '404':
          description: Document not found
components:
  schemas:
    ScheduleRequest:
      type: object
      description: Request parameters for scheduling a document
      properties:
        parameters:
          type: array
          description: Report parameters to set before execution
          items:
            type: object
            properties:
              name:
                type: string
                description: The parameter name
              value:
                type: string
                description: The parameter value
        format:
          type: string
          description: The output format for the scheduled instance (e.g., pdf, xlsx)
    ScheduleResponse:
      type: object
      description: Response from scheduling a document
      properties:
        SI_ID:
          type: integer
          description: The CMS ID of the scheduled instance
        status:
          type: string
          description: The scheduling status
  parameters:
    AcceptHeader:
      name: Accept
      in: header
      description: The desired response format
      schema:
        type: string
        enum:
        - application/json
        - application/xml
        default: application/json
  securitySchemes:
    logonToken:
      type: apiKey
      in: header
      name: X-SAP-LogonToken
      description: Logon token obtained from the /logon/long endpoint. Must be included in all subsequent API requests.
externalDocs:
  description: SAP BusinessObjects BI Platform RESTful Web Services Documentation
  url: https://help.sap.com/docs/SAP_BUSINESSOBJECTS_BUSINESS_INTELLIGENCE_PLATFORM/e8c2e5877e9e44f9bfcc3085595b9208/