SAP BI Tools Master Data API

openapi: 3.2.0
info:
  title: SAP BI Tools SAP Analytics Cloud Data Export Master Data API
  description: OData-based API for exporting fact data and master data from SAP Analytics Cloud models.
  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: Master Data
  description: Provider service endpoints for retrieving master data from specific model dimensions. Master data includes the dimension member lists with their attributes and hierarchies.
paths:
  /providers/sac/{modelId}/MasterData:
    get:
      operationId: getMasterDataOverview
      summary: SAP BI Tools Get master data overview
      description: Retrieves an overview of available master data (dimension members with navigation attributes) from a specific model. Returns fact data enriched with dimension property values.
      tags:
      - Master Data
      parameters:
      - $ref: '#/components/parameters/ModelIdParam'
      - $ref: '#/components/parameters/FormatParam'
      - $ref: '#/components/parameters/ODataTopParam'
      - $ref: '#/components/parameters/ODataSkipParam'
      responses:
        '200':
          description: Successfully retrieved master data overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataCollection'
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: Model not found
  /providers/sac/{modelId}/{dimensionName}Master:
    get:
      operationId: getDimensionMasterData
      summary: SAP BI Tools Get master data for a dimension
      description: Retrieves the master data (member list with attributes) for a specific dimension within a model. The dimension name is appended with 'Master' to form the entity set name. Supports OData query parameters for filtering and pagination.
      tags:
      - Master Data
      parameters:
      - $ref: '#/components/parameters/ModelIdParam'
      - name: dimensionName
        in: path
        required: true
        description: The technical name of the dimension whose master data to retrieve
        schema:
          type: string
      - $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 dimension master data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ODataCollection'
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: Model or dimension not found
components:
  parameters:
    ModelIdParam:
      name: modelId
      in: path
      required: true
      description: The unique provider (model) identifier
      schema:
        type: string
    FormatParam:
      name: $format
      in: query
      description: The response format (JSON or XML)
      schema:
        type: string
        enum:
        - JSON
        - XML
        default: JSON
    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
    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
  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