SAP Business Intelligence Connections API

openapi: 3.1.0
info:
  title: SAP Business Intelligence SAP Analytics Cloud Catalog Connections 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: Connections
  description: Manage data source connections
paths:
  /spaces/{spaceId}/connections:
    get:
      operationId: listConnections
      summary: SAP Business Intelligence List connections in a space
      description: Retrieve all data source connections configured in a specific space.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/spaceId'
      responses:
        '200':
          description: List of connections
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionCollection'
        '401':
          description: Unauthorized
        '404':
          description: Space not found
    post:
      operationId: createConnection
      summary: SAP Business Intelligence Create a connection
      description: Create a new data source connection in a specific space.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/spaceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConnectionRequest'
      responses:
        '201':
          description: Connection created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: Space not found
  /spaces/{spaceId}/connections/{connectionId}:
    get:
      operationId: getConnection
      summary: SAP Business Intelligence Get a connection
      description: Retrieve details of a specific data source connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/connectionId'
      responses:
        '200':
          description: Connection details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
        '401':
          description: Unauthorized
        '404':
          description: Connection not found
    delete:
      operationId: deleteConnection
      summary: SAP Business Intelligence Delete a connection
      description: Delete an existing data source connection.
      tags:
      - Connections
      parameters:
      - $ref: '#/components/parameters/spaceId'
      - $ref: '#/components/parameters/connectionId'
      responses:
        '204':
          description: Connection deleted
        '401':
          description: Unauthorized
        '404':
          description: Connection not found
components:
  parameters:
    connectionId:
      name: connectionId
      in: path
      required: true
      description: Connection unique identifier
      schema:
        type: string
    spaceId:
      name: spaceId
      in: path
      required: true
      description: Space unique identifier
      schema:
        type: string
  schemas:
    CreateConnectionRequest:
      type: object
      required:
      - name
      - type
      properties:
        name:
          type: string
          description: Connection name
        description:
          type: string
          description: Connection description
        type:
          type: string
          description: Connection type
        properties:
          type: object
          description: Connection-specific properties (host, port, credentials, etc.)
    ConnectionCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Connection'
    Connection:
      type: object
      properties:
        id:
          type: string
          description: Connection unique identifier
        name:
          type: string
          description: Connection name
        description:
          type: string
          description: Connection description
        type:
          type: string
          enum:
          - HANA
          - S4HANA
          - SAP_BW
          - SAP_BW4HANA
          - ABAP_CDS
          - OData
          - Cloud_Data_Integration
          - Google_BigQuery
          - Microsoft_SQL_Server
          - Amazon_S3
          description: Connection type
        status:
          type: string
          enum:
          - Active
          - Inactive
          - Error
          description: Connection status
        createdTime:
          type: string
          format: date-time
          description: When the connection was created
  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