Cumulocity Measurements API

openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Measurements 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: Measurements
paths:
  /measurement/measurements:
    get:
      tags:
      - Measurements
      summary: List Measurements
      operationId: listMeasurements
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: valueFragmentType
        in: query
        schema:
          type: string
      - name: valueFragmentSeries
        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
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/CurrentPage'
      responses:
        '200':
          description: A collection of measurements.
          content:
            application/vnd.com.nsn.cumulocity.measurementCollection+json:
              schema:
                $ref: '#/components/schemas/MeasurementCollection'
    post:
      tags:
      - Measurements
      summary: Create a Measurement
      operationId: createMeasurement
      requestBody:
        required: true
        content:
          application/vnd.com.nsn.cumulocity.measurement+json:
            schema:
              $ref: '#/components/schemas/Measurement'
          application/vnd.com.nsn.cumulocity.measurementCollection+json:
            schema:
              $ref: '#/components/schemas/MeasurementCollection'
      responses:
        '201':
          description: Measurement created.
          content:
            application/vnd.com.nsn.cumulocity.measurement+json:
              schema:
                $ref: '#/components/schemas/Measurement'
    delete:
      tags:
      - Measurements
      summary: Delete Measurements by Filter
      operationId: deleteMeasurements
      parameters:
      - name: source
        in: query
        schema:
          type: string
      - name: type
        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
      responses:
        '204':
          description: Measurements deleted.
  /measurement/measurements/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Measurements
      summary: Retrieve a Measurement
      operationId: getMeasurement
      responses:
        '200':
          description: A single measurement.
          content:
            application/vnd.com.nsn.cumulocity.measurement+json:
              schema:
                $ref: '#/components/schemas/Measurement'
    delete:
      tags:
      - Measurements
      summary: Delete a Measurement
      operationId: deleteMeasurement
      responses:
        '204':
          description: Measurement deleted.
components:
  schemas:
    Measurement:
      type: object
      required:
      - time
      - type
      - source
      properties:
        id:
          type: string
          readOnly: true
        self:
          type: string
          format: uri
          readOnly: true
        time:
          type: string
          format: date-time
        type:
          type: string
        source:
          type: object
          properties:
            id:
              type: string
            self:
              type: string
              format: uri
      additionalProperties: true
    MeasurementCollection:
      type: object
      properties:
        self:
          type: string
          format: uri
        measurements:
          type: array
          items:
            $ref: '#/components/schemas/Measurement'
  parameters:
    PageSize:
      name: pageSize
      in: query
      schema:
        type: integer
        minimum: 1
        maximum: 2000
        default: 5
    CurrentPage:
      name: currentPage
      in: query
      schema:
        type: integer
        minimum: 1
        default: 1
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT