SAP Business Intelligence Folders API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Folders 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: Folders
  description: Manage content folders
paths:
  /folders:
    get:
      operationId: listFolders
      summary: SAP Business Intelligence List folders
      description: Retrieve a list of content folders in the SAP Analytics Cloud tenant.
      tags:
      - Folders
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of folders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FolderCollection'
        '401':
          description: Unauthorized
  /folders/{folderId}:
    get:
      operationId: getFolder
      summary: SAP Business Intelligence Get a folder
      description: Retrieve details and contents of a specific folder.
      tags:
      - Folders
      parameters:
      - $ref: '#/components/parameters/folderId'
      responses:
        '200':
          description: Folder details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Folder'
        '401':
          description: Unauthorized
        '404':
          description: Folder 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
    folderId:
      name: folderId
      in: path
      required: true
      description: Folder 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:
    Folder:
      type: object
      properties:
        id:
          type: string
          description: Folder unique identifier
        name:
          type: string
          description: Folder name
        description:
          type: string
          description: Folder description
        parentFolderId:
          type: string
          description: Parent folder ID
        createdBy:
          type: string
          description: User who created the folder
        createdTime:
          type: string
          format: date-time
          description: When the folder was created
    FolderCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Folder'
        totalCount:
          type: integer
          description: Total number of folders
  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