SAP Business Intelligence Tasks API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Tasks 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: Tasks
  description: Manage and monitor task execution
paths:
  /tasks:
    get:
      operationId: listTasks
      summary: SAP Business Intelligence List tasks
      description: Retrieve a list of task executions across the tenant.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - name: status
        in: query
        description: Filter by task status
        schema:
          type: string
          enum:
          - Running
          - Completed
          - Failed
      responses:
        '200':
          description: List of tasks
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskRunCollection'
        '401':
          description: Unauthorized
  /tasks/{taskId}:
    get:
      operationId: getTask
      summary: SAP Business Intelligence Get a task
      description: Retrieve details and status of a specific task execution.
      tags:
      - Tasks
      parameters:
      - $ref: '#/components/parameters/taskId'
      responses:
        '200':
          description: Task details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskRun'
        '401':
          description: Unauthorized
        '404':
          description: Task not found
components:
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 1000
    taskId:
      name: taskId
      in: path
      required: true
      description: Task execution unique identifier
      schema:
        type: string
    offsetParam:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
  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
    TaskRunCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/TaskRun'
        totalCount:
          type: integer
          description: Total number of task runs
  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