Cumulocity Events API

openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Events 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: Events
paths:
  /event/events:
    get:
      tags:
      - Events
      summary: List Events
      operationId: listEvents
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: fragmentType
        in: query
        schema:
          type: string
      - name: dateFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        schema:
          type: string
          format: date-time
      - name: revert
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: A collection of events.
          content:
            application/vnd.com.nsn.cumulocity.eventCollection+json:
              schema:
                $ref: '#/components/schemas/EventCollection'
    post:
      tags:
      - Events
      summary: Create an Event
      operationId: createEvent
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.event+json:
            schema:
              $ref: '#/components/schemas/Event'
      responses:
        '201':
          description: Event created.
          content:
            application/vnd.com.nsn.cumulocity.event+json:
              schema:
                $ref: '#/components/schemas/Event'
    delete:
      tags:
      - Events
      summary: Delete Events by Filter
      operationId: deleteEvents
      responses:
        '204':
          description: Events deleted.
  /event/events/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Events
      summary: Retrieve an Event
      operationId: getEvent
      responses:
        '200':
          description: A single event.
          content:
            application/vnd.com.nsn.cumulocity.event+json:
              schema:
                $ref: '#/components/schemas/Event'
    put:
      tags:
      - Events
      summary: Update an Event
      operationId: updateEvent
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.event+json:
            schema:
              $ref: '#/components/schemas/Event'
      responses:
        '200':
          description: Event updated.
    delete:
      tags:
      - Events
      summary: Delete an Event
      operationId: deleteEvent
      responses:
        '204':
          description: Event deleted.
components:
  schemas:
    EventCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
    Event:
      type: object
      required:
      - time
      - type
      - text
      - source
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        time:
          type: string
          format: date-time
        creationTime:
          type: string
          format: date-time
          readOnly: true
        type:
          type: string
        text:
          type: string
        source:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
      additionalProperties: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT