SAP Business Intelligence Spaces API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Spaces 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: Spaces
  description: Manage Datasphere spaces
paths:
  /spaces:
    get:
      operationId: listSpaces
      summary: SAP Business Intelligence List spaces
      description: Retrieve a list of all spaces the authenticated user has access to.
      tags:
      - Spaces
      parameters:
      - $ref: '#/components/parameters/limitParam'
      - $ref: '#/components/parameters/offsetParam'
      responses:
        '200':
          description: List of spaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpaceCollection'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
    post:
      operationId: createSpace
      summary: SAP Business Intelligence Create a space
      description: Create a new Datasphere space with specified configuration.
      tags:
      - Spaces
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpaceRequest'
      responses:
        '201':
          description: Space created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Space'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
  /spaces/{spaceId}:
    get:
      operationId: getSpace
      summary: SAP Business Intelligence Get a space
      description: Retrieve details of a specific Datasphere space.
      tags:
      - Spaces
      parameters:
      - $ref: '#/components/parameters/spaceId'
      responses:
        '200':
          description: Space details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Space'
        '401':
          description: Unauthorized
        '404':
          description: Space not found
    put:
      operationId: updateSpace
      summary: SAP Business Intelligence Update a space
      description: Update properties of an existing Datasphere space.
      tags:
      - Spaces
      parameters:
      - $ref: '#/components/parameters/spaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSpaceRequest'
      responses:
        '200':
          description: Space updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Space'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: Space not found
    delete:
      operationId: deleteSpace
      summary: SAP Business Intelligence Delete a space
      description: Delete an existing Datasphere space and its contents.
      tags:
      - Spaces
      parameters:
      - $ref: '#/components/parameters/spaceId'
      responses:
        '204':
          description: Space deleted
        '401':
          description: Unauthorized
        '404':
          description: Space 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
    spaceId:
      name: spaceId
      in: path
      required: true
      description: Space 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:
    SpaceCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Space'
        totalCount:
          type: integer
          description: Total number of spaces
    SpaceMember:
      type: object
      properties:
        userId:
          type: string
          description: User identifier
        role:
          type: string
          enum:
          - Admin
          - Modeler
          - Viewer
          description: Member role in the space
    Space:
      type: object
      properties:
        id:
          type: string
          description: Space unique identifier
        name:
          type: string
          description: Space name
        description:
          type: string
          description: Space description
        storageAssignment:
          type: string
          enum:
          - InMemory
          - Disk
          description: Storage type assignment
        diskStorageQuota:
          type: integer
          description: Disk storage quota in GB
        memoryStorageQuota:
          type: integer
          description: In-memory storage quota in GB
        members:
          type: array
          items:
            $ref: '#/components/schemas/SpaceMember'
          description: Space members
        createdBy:
          type: string
          description: User who created the space
        createdTime:
          type: string
          format: date-time
          description: When the space was created
        modifiedTime:
          type: string
          format: date-time
          description: When the space was last modified
    UpdateSpaceRequest:
      type: object
      properties:
        name:
          type: string
          description: Updated name
        description:
          type: string
          description: Updated description
        diskStorageQuota:
          type: integer
          description: Updated disk storage quota in GB
        memoryStorageQuota:
          type: integer
          description: Updated in-memory storage quota in GB
    CreateSpaceRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name for the new space
        description:
          type: string
          description: Description for the space
        diskStorageQuota:
          type: integer
          description: Disk storage quota in GB
        memoryStorageQuota:
          type: integer
          description: In-memory storage quota in GB
  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