SAP Business Intelligence Process Chains API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Process Chains API
  description: REST API for SAP Analytics Cloud enabling data integration, story management, model administration, and analytics operations. Provides programmatic access to create and manage stories, models, data imports, and user administration within SAP Analytics Cloud.
  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}.sapanalytics.cloud/api/v1
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: mytenant
      description: SAP Analytics Cloud tenant identifier
security:
- oauth2: []
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:
    topParam:
      name: $top
      in: query
      description: Maximum number of results to return (OData)
      schema:
        type: integer
        default: 100
        minimum: 1
    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
    formatParam:
      name: $format
      in: query
      description: Response format
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  schemas:
    ProcessChainCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/ProcessChain'
    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
    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
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication for SAP Analytics Cloud
      flows:
        clientCredentials:
          tokenUrl: https://{tenant}.sapanalytics.cloud/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD