SAP Business Intelligence InfoProviders API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog InfoProviders 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: 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:
  schemas:
    KeyFigureCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/KeyFigure'
    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
    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
    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
    BwDimensionCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/BwDimension'
  parameters:
    topParam:
      name: $top
      in: query
      description: Maximum number of results to return (OData)
      schema:
        type: integer
        default: 100
        minimum: 1
    filterParam:
      name: $filter
      in: query
      description: OData filter expression
      schema:
        type: string
    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
    infoProviderName:
      name: infoProviderName
      in: path
      required: true
      description: InfoProvider technical name
      schema:
        type: string
    formatParam:
      name: $format
      in: query
      description: Response format
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  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