SAP Business Intelligence Queries API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Queries 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: Queries
  description: Execute and manage BW queries
paths:
  /RSOD_BW_QUERY_SRV/Queries:
    get:
      operationId: listQueries
      summary: SAP Business Intelligence List BW queries
      description: Retrieve a list of all BW queries available in the system.
      tags:
      - Queries
      parameters:
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/filterParam'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of queries
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryCollection'
        '401':
          description: Unauthorized
  /RSOD_BW_QUERY_SRV/Queries('{queryName}'):
    get:
      operationId: getQuery
      summary: SAP Business Intelligence Get a BW query
      description: Retrieve metadata of a specific BW query.
      tags:
      - Queries
      parameters:
      - $ref: '#/components/parameters/queryName'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: Query details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BwQuery'
        '401':
          description: Unauthorized
        '404':
          description: Query not found
  /RSOD_BW_QUERY_SRV/Queries('{queryName}')/Execute:
    post:
      operationId: executeQuery
      summary: SAP Business Intelligence Execute a BW query
      description: Execute a BW query with optional variable values and retrieve the result set.
      tags:
      - Queries
      parameters:
      - $ref: '#/components/parameters/queryName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QueryExecutionRequest'
      responses:
        '200':
          description: Query result set
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResult'
        '400':
          description: Invalid query parameters
        '401':
          description: Unauthorized
        '404':
          description: Query not found
components:
  parameters:
    queryName:
      name: queryName
      in: path
      required: true
      description: BW query technical name
      schema:
        type: string
    filterParam:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    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
    formatParam:
      name: $format
      in: query
      description: Response format
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  schemas:
    QueryResult:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                type: object
              description: Result rows
            __count:
              type: string
              description: Total result count
    QueryExecutionRequest:
      type: object
      properties:
        Variables:
          type: array
          items:
            type: object
            properties:
              VariableName:
                type: string
                description: Variable technical name
              Value:
                type: string
                description: Variable value
          description: Query variable values
    QueryCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/BwQuery'
    BwQuery:
      type: object
      properties:
        QueryName:
          type: string
          description: Technical name of the query
        QueryDescription:
          type: string
          description: Description of the query
        InfoProviderName:
          type: string
          description: Underlying InfoProvider
        CreatedBy:
          type: string
          description: User who created the query
        ChangedAt:
          type: string
          format: date-time
          description: Last modification timestamp
  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