openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Subscriptions API
  version: 10.20.0
  description: 'Raise, query, acknowledge, clear, and bulk-update alarms with four severity levels (CRITICAL, MAJOR,

    MINOR, WARNING) and four statuses (ACTIVE, ACKNOWLEDGED, CLEARED). Cumulocity auto-deduplicates alarms

    by source + type so repeated raises increment the count rather than creating duplicates.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Subscriptions
paths:
  /notification2/subscriptions:
    get:
      tags:
      - Subscriptions
      summary: List Notification 2.0 Subscriptions
      operationId: listSubscriptions
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: context
        in: query
        schema:
          type: string
          enum:
          - tenant
          - mo
      - name: subscription
        in: query
        schema:
          type: string
      responses:
        '200':
          description: A collection of subscriptions.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionCollection'
    post:
      tags:
      - Subscriptions
      summary: Create a Subscription
      operationId: createSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Subscription'
      responses:
        '201':
          description: Subscription created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
    delete:
      tags:
      - Subscriptions
      summary: Delete Subscriptions by Filter
      operationId: deleteSubscriptions
      responses:
        '204':
          description: Subscriptions deleted.
  /notification2/subscriptions/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Subscriptions
      summary: Retrieve a Subscription
      operationId: getSubscription
      responses:
        '200':
          description: A single subscription.
    delete:
      tags:
      - Subscriptions
      summary: Delete a Subscription
      operationId: deleteSubscription
      responses:
        '204':
          description: Subscription deleted.
components:
  schemas:
    SubscriptionCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription'
    Subscription:
      type: object
      required:
      - subscription
      - context
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        subscription:
          type: string
        context:
          type: string
          enum:
          - tenant
          - mo
        source:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
        fragmentsToCopy:
          type: array
          items:
            type: string
        subscriptionFilter:
          type: object
          properties:
            apis:
              type: array
              items:
                type: string
                enum:
                - alarms
                - events
                - eventsWithChildren
                - managedobjects
                - measurements
                - operations
            typeFilter:
              type: string
        nonPersistent:
          type: boolean
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT