SAP Business Intelligence Data Store Objects API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Data Store Objects 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: Data Store Objects
  description: Manage advanced data store objects (aDSO)
paths:
  /RSOD_ADSO_SRV/DataStoreObjects:
    get:
      operationId: listDataStoreObjects
      summary: SAP Business Intelligence List data store objects
      description: Retrieve a list of all advanced data store objects (aDSO) in the system.
      tags:
      - Data Store Objects
      parameters:
      - $ref: '#/components/parameters/topParam'
      - $ref: '#/components/parameters/skipParam'
      - $ref: '#/components/parameters/filterParam'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: List of data store objects
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreObjectCollection'
        '401':
          description: Unauthorized
  /RSOD_ADSO_SRV/DataStoreObjects('{adsoName}'):
    get:
      operationId: getDataStoreObject
      summary: SAP Business Intelligence Get a data store object
      description: Retrieve details and metadata of a specific advanced data store object.
      tags:
      - Data Store Objects
      parameters:
      - $ref: '#/components/parameters/adsoName'
      - $ref: '#/components/parameters/formatParam'
      responses:
        '200':
          description: Data store object details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataStoreObject'
        '401':
          description: Unauthorized
        '404':
          description: Data store object not found
components:
  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
    adsoName:
      name: adsoName
      in: path
      required: true
      description: Advanced data store object technical name
      schema:
        type: string
    formatParam:
      name: $format
      in: query
      description: Response format
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
  schemas:
    DataStoreObject:
      type: object
      properties:
        DataStoreObjectName:
          type: string
          description: Technical name of the aDSO
        DataStoreObjectDescription:
          type: string
          description: Description of the aDSO
        DataStoreObjectType:
          type: string
          enum:
          - Standard
          - WriteOptimized
          - DirectUpdate
          description: Data store object type
        InfoArea:
          type: string
          description: InfoArea containing the aDSO
        ActivationStatus:
          type: string
          enum:
          - Active
          - Inactive
          - Modified
          description: Current activation status
        RecordCount:
          type: integer
          description: Number of records in the active table
    DataStoreObjectCollection:
      type: object
      properties:
        d:
          type: object
          properties:
            results:
              type: array
              items:
                $ref: '#/components/schemas/DataStoreObject'
  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