SAP Business Intelligence Process Chains API

openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BW/4HANA OData Process Chains API
  description: OData services for accessing SAP BW/4HANA data warehouse content and metadata. Provides programmatic access to query InfoProviders, manage data store objects, browse metadata, and execute analytical queries against the BW/4HANA data warehouse.
  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}/sap/opu/odata/sap
  description: SAP BW/4HANA OData Endpoint
  variables:
    server:
      default: localhost
      description: BW/4HANA server hostname
    port:
      default: '443'
      description: BW/4HANA server port
security:
- basicAuth: []
tags:
- name: Process Chains
  description: Monitor and manage process chains
paths:
  /RSPC_API_SRV/ProcessChains:
    get:
      operationId: listProcessChains
      summary: SAP Business Intelligence List process chains
      description: Retrieve a list of all process chains in the BW/4HANA system.
      tags:
      - Process Chains
      parameters:
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of process chains
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessChainCollection'
        '401':
          description: Unauthorized
  /RSPC_API_SRV/ProcessChains('{chainId}'):
    get:
      operationId: getProcessChain
      summary: SAP Business Intelligence Get a process chain
      description: Retrieve details and execution history of a specific process chain.
      tags:
      - Process Chains
      parameters:
      - $ref: '#/components/parameters/chainId'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: Process chain details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessChain'
        '401':
          description: Unauthorized
        '404':
          description: Process chain not found
  /RSPC_API_SRV/ProcessChains('{chainId}')/Start:
    post:
      operationId: startProcessChain
      summary: SAP Business Intelligence Start a process chain
      description: Trigger execution of a process chain.
      tags:
      - Process Chains
      parameters:
      - $ref: '#/components/parameters/chainId'
      responses:
        '202':
          description: Process chain execution started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessChainRun'
        '401':
          description: Unauthorized
        '404':
          description: Process chain not found
components:
  parameters:
    formatParam:
      name: $format
      in: query
      description: Response format
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
    skipParam:
      name: $skip
      in: query
      description: Number of results to skip for pagination (OData)
      schema:
        type: integer
        default: 0
        minimum: 0
    chainId:
      name: chainId
      in: path
      required: true
      description: Process chain identifier
      schema:
        type: string
    topParam:
      name: $top
      in: query
      description: Maximum number of results to return (OData)
      schema:
        type: integer
        default: 100
        minimum: 1
  schemas:
    ProcessChain:
      type: object
      properties:
        ChainId:
          type: string
          description: Process chain identifier
        Description:
          type: string
          description: Process chain description
        Status:
          type: string
          enum:
          - Active
          - Inactive
          description: Chain status
        LastRunStatus:
          type: string
          enum:
          - Green
          - Yellow
          - Red
          description: Status of the last execution
        LastRunTime:
          type: string
          format: date-time
          description: When the chain last ran
    ProcessChainRun:
      type: object
      properties:
        RunId:
          type: string
          description: Execution run identifier
        Status:
          type: string
          enum:
          - Started
          - Running
          description: Initial run status
        StartTime:
          type: string
          format: date-time
          description: When the execution started
    ProcessChainCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/ProcessChain'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: SAP user credentials for BW/4HANA system
externalDocs:
  description: SAP BW/4HANA OData API Documentation
  url: https://help.sap.com/docs/SAP_BW4HANA