SAP Business Intelligence InfoProviders API

openapi: 3.2.0
info:
  title: SAP Business Intelligence SAP BW/4HANA OData Info Providers 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: InfoProviders
  description: Access InfoProvider metadata and data
paths:
  /RSOD_INFOPROV_SRV/InfoProviders:
    get:
      operationId: listInfoProviders
      summary: SAP Business Intelligence List InfoProviders
      description: Retrieve a list of all InfoProviders (InfoCubes, DataStore Objects, CompositeProviders) available in the BW/4HANA system.
      tags:
      - InfoProviders
      parameters:
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/filterParam'
      - $ref: '#/components/parameters/selectParam'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of InfoProviders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoProviderCollection'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
  /RSOD_INFOPROV_SRV/InfoProviders('{infoProviderName}'):
    get:
      operationId: getInfoProvider
      summary: SAP Business Intelligence Get an InfoProvider
      description: Retrieve details and metadata of a specific InfoProvider.
      tags:
      - InfoProviders
      parameters:
      - $ref: '#/components/parameters/infoProviderName'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: InfoProvider details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InfoProvider'
        '401':
          description: Unauthorized
        '404':
          description: InfoProvider not found
  /RSOD_INFOPROV_SRV/InfoProviders('{infoProviderName}')/Dimensions:
    get:
      operationId: listInfoProviderDimensions
      summary: SAP Business Intelligence List InfoProvider dimensions
      description: Retrieve all dimensions associated with a specific InfoProvider.
      tags:
      - InfoProviders
      parameters:
      - $ref: '#/components/parameters/infoProviderName'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of dimensions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BwDimensionCollection'
        '401':
          description: Unauthorized
        '404':
          description: InfoProvider not found
  /RSOD_INFOPROV_SRV/InfoProviders('{infoProviderName}')/KeyFigures:
    get:
      operationId: listInfoProviderKeyFigures
      summary: SAP Business Intelligence List InfoProvider key figures
      description: Retrieve all key figures (measures) associated with a specific InfoProvider.
      tags:
      - InfoProviders
      parameters:
      - $ref: '#/components/parameters/infoProviderName'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of key figures
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyFigureCollection'
        '401':
          description: Unauthorized
        '404':
          description: InfoProvider 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
    selectParam:
      name: $select
      in: query
      description: Comma-separated list of properties to return
      schema:
        type: string
    filterParam:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    infoProviderName:
      name: infoProviderName
      in: path
      required: true
      description: InfoProvider 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:
    KeyFigureCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/KeyFigure'
    BwDimension:
      type: object
      properties:
        DimensionName:
          type: string
          description: Technical name of the dimension
        DimensionDescription:
          type: string
          description: Description of the dimension
        DimensionType:
          type: string
          description: Dimension type
        InfoObjectName:
          type: string
          description: Associated InfoObject technical name
    InfoProvider:
      type: object
      properties:
        InfoProviderName:
          type: string
          description: Technical name of the InfoProvider
        InfoProviderDescription:
          type: string
          description: Description of the InfoProvider
        InfoProviderType:
          type: string
          enum:
          - ADSO
          - CompositeProvider
          - InfoCube
          - InfoObject
          description: Type of InfoProvider
        InfoArea:
          type: string
          description: InfoArea containing the InfoProvider
        CreatedBy:
          type: string
          description: User who created the InfoProvider
        CreatedAt:
          type: string
          format: date-time
          description: Creation timestamp
        ChangedBy:
          type: string
          description: User who last changed the InfoProvider
        ChangedAt:
          type: string
          format: date-time
          description: Last change timestamp
    BwDimensionCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/BwDimension'
    InfoProviderCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/InfoProvider'
    KeyFigure:
      type: object
      properties:
        KeyFigureName:
          type: string
          description: Technical name of the key figure
        KeyFigureDescription:
          type: string
          description: Description of the key figure
        AggregationType:
          type: string
          enum:
          - SUM
          - MIN
          - MAX
          - AVG
          - COUNT
          - NOP
          description: Aggregation behavior
        DataType:
          type: string
          description: Data type of the key figure
        UnitOfMeasure:
          type: string
          description: Unit of measure or currency
  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