SAP BI Tools Calendars API

openapi: 3.1.0
info:
  title: SAP BI Tools SAP Analytics Cloud Administration Calendars API
  description: RESTful API for SAP Analytics Cloud enabling programmatic access to system data stored on an SAP Analytics Cloud tenant. The API provides endpoints for managing stories, models, users, teams, calendars, and other resources. It supports SCIM 2.0 for user provisioning, OData for data access, and standard REST patterns for content management. Authentication uses OAuth 2.0 with SAML bearer assertion or authorization code grant flows.
  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}.{datacenter}.sapanalytics.cloud
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: my-tenant
      description: The SAP Analytics Cloud tenant name
    datacenter:
      default: eu1
      description: The data center region (e.g., eu1, eu10, us1, us10, ap1)
security:
- oauth2: []
tags:
- name: Calendars
  description: Manage calendar events and tasks used for planning workflows and scheduling in SAP Analytics Cloud.
paths:
  /api/v1/calendars:
    get:
      operationId: listCalendars
      summary: SAP BI Tools List calendar events
      description: Retrieves a list of calendar events and tasks configured in SAP Analytics Cloud. Calendars support planning workflows, scheduling notifications, and organizing collaborative tasks.
      tags:
      - Calendars
      responses:
        '200':
          description: Successfully retrieved calendar events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CalendarEvent'
        '401':
          description: Unauthorized - invalid or missing authentication token
components:
  schemas:
    CalendarEvent:
      type: object
      description: Represents a calendar event or task in SAP Analytics Cloud used for planning workflows and scheduling.
      properties:
        id:
          type: string
          description: The unique identifier of the calendar event
        name:
          type: string
          description: The name of the calendar event
        description:
          type: string
          description: A description of the event
        startDate:
          type: string
          format: date-time
          description: The start date and time of the event
        endDate:
          type: string
          format: date-time
          description: The end date and time of the event
        status:
          type: string
          description: The current status of the event
          enum:
          - NOT_STARTED
          - IN_PROGRESS
          - COMPLETED
        assignee:
          type: string
          description: The user assigned to the event
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAML bearer assertion or authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/authorize
          tokenUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud REST API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/3ccfab3348dd407db089accb66cff9a2.html