SAP BI Tools Administration API

openapi: 3.2.0
info:
  title: SAP BI Tools SAP Analytics Cloud Data Export Administration API
  description: 'OData-based API for exporting fact data and master data from SAP Analytics Cloud models. The API consists of two services: the Administration service for discovering available models (providers) and namespaces, and the Provider service for retrieving metadata, fact data, and master data from specific planning models. Supports standard OData query parameters for filtering, selecting, and paging data. Enables programmatic extraction of underlying data for integration with external systems and data pipelines.'
  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}.{datacenter}.sapanalytics.cloud/api/v1/dataexport
  description: SAP Analytics Cloud Data Export Service
  variables:
    tenant:
      default: my-tenant
      description: The SAP Analytics Cloud tenant name
    datacenter:
      default: eu1
      description: The data center region (e.g., eu1, eu10, us1, us10, ap1)
security:
- oauth2: []
tags:
- name: Administration
  description: Administration service endpoints for discovering available namespaces and providers (models) on the SAP Analytics Cloud tenant.
paths:
  /administration/Namespaces:
    get:
      operationId: listNamespaces
      summary: SAP BI Tools List available namespaces
      description: Retrieves a list of namespaces available for data export. The primary namespace is 'sac' which contains all SAP Analytics Cloud models.
      tags:
      - Administration
      parameters:
      - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Successfully retrieved list of namespaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataCollection'
        '401':
          description: Unauthorized - invalid or missing authentication token
  /administration/Namespaces(NamespaceID='{namespaceId}')/Providers:
    get:
      operationId: listProviders
      summary: SAP BI Tools List available providers (models)
      description: Retrieves a list of providers (models) available for data export within a specific namespace. Each provider represents an SAP Analytics Cloud model with its name, description, and provider ID that can be used to access its data.
      tags:
      - Administration
      parameters:
      - $ref: '#/components/parameters/NamespaceIdParam'
      - $ref: '#/components/parameters/FormatParam'
      - $ref: '#/components/parameters/ODataTopParam'
      - $ref: '#/components/parameters/ODataSkipParam'
      - $ref: '#/components/parameters/ODataFilterParam'
      - $ref: '#/components/parameters/ODataSelectParam'
      responses:
        '200':
          description: Successfully retrieved list of providers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderCollection'
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: Namespace not found
components:
  parameters:
    NamespaceIdParam:
      name: namespaceId
      in: path
      required: true
      description: The namespace identifier (typically 'sac')
      schema:
        type: string
        default: sac
    ODataFilterParam:
      name: $filter
      in: query
      description: OData filter expression to apply
      schema:
        type: string
    ODataSkipParam:
      name: $skip
      in: query
      description: Number of records to skip for pagination
      schema:
        type: integer
    FormatParam:
      name: $format
      in: query
      description: The response format (JSON or XML)
      schema:
        type: string
        enum:
        - JSON
        - XML
        default: JSON
    ODataTopParam:
      name: $top
      in: query
      description: Maximum number of records to return
      schema:
        type: integer
    ODataSelectParam:
      name: $select
      in: query
      description: Comma-separated list of properties to include
      schema:
        type: string
  schemas:
    ODataCollection:
      type: object
      description: A standard OData collection response wrapper
      properties:
        '@odata.context':
          type: string
          description: The OData context URL
        value:
          type: array
          description: The collection of results
          items:
            type: object
    ProviderCollection:
      type: object
      description: A collection of providers (models) available for export
      properties:
        '@odata.context':
          type: string
          description: The OData context URL
        value:
          type: array
          description: The list of providers
          items:
            $ref: '#/components/schemas/Provider'
    Provider:
      type: object
      description: Represents an SAP Analytics Cloud model available for data export. Providers contain fact data and master data that can be queried via the Provider service endpoints.
      properties:
        ProviderID:
          type: string
          description: The unique provider identifier for the model
        Description:
          type: string
          description: The human-readable description of the model
        ProviderName:
          type: string
          description: The display name of the model
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAML bearer assertion or authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/authorize
          tokenUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud Data Export API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/db62fd76514b48f8b71d695360320f4a.html