SAP Business Intelligence Queries API

openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BW/4HANA OData Queries 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: 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:
    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
    filterParam:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    queryName:
      name: queryName
      in: path
      required: true
      description: BW query technical name
      schema:
        type: string
    topParam:
      name: $top
      in: query
      description: Maximum number of results to return (OData)
      schema:
        type: integer
        default: 100
        minimum: 1
  schemas:
    QueryCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/BwQuery'
    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
    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:
    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