SAP Business Intelligence Catalog API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog 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: Catalog
  description: Browse the Datasphere data catalog
paths:
  /catalog:
    get:
      operationId: listCatalogAssets
      summary: SAP Business Intelligence List catalog assets
      description: Browse the data catalog to discover available datasets, views, and other assets.
      tags:
      - Catalog
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      - name: search
        in: query
        description: Search catalog assets by keyword
        schema:
          type: string
      responses:
        '200':
          description: List of catalog assets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogAssetCollection'
        '401':
          description: Unauthorized
  /catalog/{assetId}:
    get:
      operationId: getCatalogAsset
      summary: SAP Business Intelligence Get a catalog asset
      description: Retrieve details and metadata of a specific catalog asset.
      tags:
      - Catalog
      parameters:
      - $ref: '#/components/parameters/assetId'
      responses:
        '200':
          description: Catalog asset details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogAsset'
        '401':
          description: Unauthorized
        '404':
          description: Catalog asset not found
components:
  parameters:
    limitParam:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 50
        minimum: 1
        maximum: 1000
    assetId:
      name: assetId
      in: path
      required: true
      description: Catalog asset unique identifier
      schema:
        type: string
    offsetParam:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
        minimum: 0
  schemas:
    CatalogAssetCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/CatalogAsset'
        totalCount:
          type: integer
          description: Total number of catalog assets
    CatalogAsset:
      type: object
      properties:
        id:
          type: string
          description: Asset unique identifier
        name:
          type: string
          description: Asset name
        description:
          type: string
          description: Asset description
        type:
          type: string
          enum:
          - Dataset
          - View
          - Table
          - Connection
          description: Asset type
        spaceId:
          type: string
          description: Space containing the asset
        owner:
          type: string
          description: Asset owner
        tags:
          type: array
          items:
            type: string
          description: Tags assigned to the asset
        createdTime:
          type: string
          format: date-time
          description: When the asset was cataloged
  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