SAP BI Tools Metadata API

openapi: 3.1.0
info:
  title: SAP BI Tools SAP Analytics Cloud Administration Metadata API
  description: RESTful API for SAP Analytics Cloud enabling programmatic access to system data stored on an SAP Analytics Cloud tenant. The API provides endpoints for managing stories, models, users, teams, calendars, and other resources. It supports SCIM 2.0 for user provisioning, OData for data access, and standard REST patterns for content management. Authentication uses OAuth 2.0 with SAML bearer assertion or authorization code grant flows.
  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
  description: SAP Analytics Cloud Tenant
  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: Metadata
  description: Provider service endpoints for retrieving OData metadata documents describing the structure of models, dimensions, and measures.
paths:
  /providers/sac/{modelId}/$metadata:
    get:
      operationId: getModelMetadata
      summary: SAP BI Tools Get model metadata
      description: Retrieves the OData metadata document for a specific model. The metadata describes the structure of the model including its dimensions, measures, and available entity sets for querying fact data and master data.
      tags:
      - Metadata
      parameters:
      - $ref: '#/components/parameters/ModelIdParam'
      - $ref: '#/components/parameters/FormatParam'
      responses:
        '200':
          description: Successfully retrieved model metadata
          content:
            application/xml:
              schema:
                type: string
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: Model 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
  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 REST API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/3ccfab3348dd407db089accb66cff9a2.html