SAP Business Intelligence Data Flows API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Data Flows 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: Data Flows
  description: Manage data replication and transformation flows
paths:
  /spaces/{spaceId}/dataflows:
    get:
      operationId: listDataFlows
      summary: SAP Business Intelligence List data flows
      description: Retrieve all data flows configured in a specific space.
      tags:
      - Data Flows
      parameters:
      - $ref: '#/components/parameters/spaceId'
      responses:
        '200':
          description: List of data flows
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlowCollection'
        '401':
          description: Unauthorized
        '404':
          description: Space not found
  /spaces/{spaceId}/dataflows/{dataFlowId}:
    get:
      operationId: getDataFlow
      summary: SAP Business Intelligence Get a data flow
      description: Retrieve details of a specific data flow.
      tags:
      - Data Flows
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/dataFlowId'
      responses:
        '200':
          description: Data flow details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFlow'
        '401':
          description: Unauthorized
        '404':
          description: Data flow not found
  /spaces/{spaceId}/dataflows/{dataFlowId}/run:
    post:
      operationId: runDataFlow
      summary: SAP Business Intelligence Run a data flow
      description: Trigger execution of a data flow to replicate or transform data.
      tags:
      - Data Flows
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/dataFlowId'
      responses:
        '202':
          description: Data flow execution started
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskRun'
        '401':
          description: Unauthorized
        '404':
          description: Data flow not found
components:
  parameters:
    spaceId:
      name: spaceId
      in: path
      required: true
      description: Space unique identifier
      schema:
        type: string
    dataFlowId:
      name: dataFlowId
      in: path
      required: true
      description: Data flow unique identifier
      schema:
        type: string
  schemas:
    TaskRun:
      type: object
      properties:
        id:
          type: string
          description: Task run unique identifier
        type:
          type: string
          enum:
          - DataFlowExecution
          - ViewDeployment
          - DataReplication
          description: Task type
        status:
          type: string
          enum:
          - Pending
          - Running
          - Completed
          - Failed
          description: Task execution status
        startTime:
          type: string
          format: date-time
          description: When the task started
        endTime:
          type: string
          format: date-time
          description: When the task completed
        rowsProcessed:
          type: integer
          description: Number of rows processed
        errorMessage:
          type: string
          description: Error message if the task failed
    DataFlowCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/DataFlow'
    DataFlow:
      type: object
      properties:
        id:
          type: string
          description: Data flow unique identifier
        name:
          type: string
          description: Data flow name
        description:
          type: string
          description: Data flow description
        type:
          type: string
          enum:
          - Replication
          - Transformation
          description: Data flow type
        status:
          type: string
          enum:
          - Active
          - Inactive
          - Error
          description: Data flow status
        sourceConnection:
          type: string
          description: Source connection ID
        targetView:
          type: string
          description: Target view ID
        lastRunTime:
          type: string
          format: date-time
          description: When the data flow last ran
        lastRunStatus:
          type: string
          enum:
          - Completed
          - Failed
          - Running
          description: Status of the last execution
  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