Cumulocity Operations API

openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Operations 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: Operations
paths:
  /devicecontrol/operations:
    get:
      tags:
      - Operations
      summary: List Operations
      operationId: listOperations
      parameters:
      - name: deviceId
        in: query
        schema:
          type: string
      - name: agentId
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
          enum:
          - PENDING
          - EXECUTING
          - SUCCESSFUL
          - FAILED
      - 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 operations.
          content:
            application/vnd.com.nsn.cumulocity.operationCollection+json:
              schema:
                $ref: '#/components/schemas/OperationCollection'
    post:
      tags:
      - Operations
      summary: Create an Operation
      operationId: createOperation
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.operation+json:
            schema:
              $ref: '#/components/schemas/Operation'
      responses:
        '201':
          description: Operation created.
    delete:
      tags:
      - Operations
      summary: Delete Operations by Filter
      operationId: deleteOperations
      responses:
        '204':
          description: Operations deleted.
  /devicecontrol/operations/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Operations
      summary: Retrieve an Operation
      operationId: getOperation
      responses:
        '200':
          description: A single operation.
          content:
            application/vnd.com.nsn.cumulocity.operation+json:
              schema:
                $ref: '#/components/schemas/Operation'
    put:
      tags:
      - Operations
      summary: Update an Operation
      operationId: updateOperation
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.operation+json:
            schema:
              $ref: '#/components/schemas/Operation'
      responses:
        '200':
          description: Operation updated.
components:
  schemas:
    Operation:
      type: object
      required:
      - deviceId
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        deviceId:
          type: string
        deviceExternalIDs:
          type: object
        agentId:
          type: string
        status:
          type: string
          enum:
          - PENDING
          - EXECUTING
          - SUCCESSFUL
          - FAILED
        creationTime:
          type: string
          format: date-time
          readOnly: true
        failureReason:
          type: string
        description:
          type: string
        c8y_Restart:
          type: object
        c8y_Command:
          type: object
          properties:
            text:
              type: string
            result:
              type: string
        c8y_Firmware:
          type: object
          properties:
            name:
              type: string
            version:
              type: string
            url:
              type: string
        c8y_Software:
          type: array
      additionalProperties: true
    OperationCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Operation'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT