Measured values, events and rules API

Use this API and its MCP server to read measured values and events and to manage rules. To send measured values, see Sending measured values. For authentication, tenants and general conventions, see Concepts.

All endpoints with their parameters and data structures: Measured values, events and rules API reference.

REST API

Base URL:

https://<sot-host>/cm/api/v1/tenants/{tenantId}

{deviceId} is the ID of the device (UUID), not the technical ID. See Master data API.

Path Methods Purpose Permission

/devices/{deviceId}/measurements/raw

GET

Measured values of a device

measurements:read

/devices/{deviceId}/measuringPoints

GET

Measuring points of a device

devices:read

/devices/{deviceId}/events

GET

Events of a device, newest first

events:read

/rules

GET, POST

List rules, create a rule

rules:read, rules:write

/rules/{ruleId}

GET, PUT, DELETE

Read, replace or delete a rule

rules:read, rules:write, rules:delete

Measured values

Parameter Description

measurement

Comma-separated names of measuring points. Without this parameter, all measuring points are returned.

from, to

Time range in RFC 3339, both inclusive. The time range can cover at most 7 days.

sortOrder

asc or desc.

pageSize

Values per page, at most 10,000.

cursor, asOf

Continue with the next page. Use both values from the previous response, with the same sortOrder.

Events

Parameter Description

from, to

Time range in RFC 3339.

severity

warning or error.

measuringPoint

Name of the measuring point.

pageSize

Events per page, at most 100.

cursor, asOf

Continue with the next page.

Rules

A rule has a name, a rule definition, a measuring point, the devices and parameters. Rule definitions: upper_bound, lower_bound, jump, static_tolerance_check and trend. See How rules work for the meaning of the parameters.

List parameters: page, pageSize (at most 100), sortBy, sortOrder, filter, search.

Errors

{
  "code": "ERR_VALIDATION",
  "message": "human-readable message"
}

MCP server

https://<sot-host>/cm/api/v1/tenants/{tenantId}/mcp
Tool Purpose Permission

sot-condition-monitoring_list_device_measuring_points

Measuring points of a device

devices:read

sot-condition-monitoring_query_measurements

Measured values of a device; at most 10,000 values per page, at most 7 days

measurements:read

sot-condition-monitoring_list_device_events

Events of a device with filters

events:read

sot-condition-monitoring_query_rules

List rules or read one rule

rules:read

sot-condition-monitoring_manage_rules

Create or replace a rule for 1 to 50 devices

rules:write

sot-condition-monitoring_delete_rules

Delete a rule

rules:delete

The tools expect the device UUID. Use sot-mdm_query_devices to find it. The measurement tool returns raw values; it does not calculate statistics.

API für Messwerte, Ereignisse und Regeln

Diese API und ihr MCP-Server dienen zum Lesen von Messwerten und Ereignissen und zum Verwalten von Regeln. Messwerte senden: siehe Messwerte senden. Authentifizierung, Tenants und allgemeine Konventionen: siehe Konzepte.

Alle Endpunkte mit ihren Parametern und Datenstrukturen: Referenz der API für Messwerte, Ereignisse und Regeln.

REST-API

Basis-URL:

https://<sot-host>/cm/api/v1/tenants/{tenantId}

{deviceId} ist die ID des Geräts (UUID), nicht die technische ID. Siehe Stammdaten-API.

Pfad Methoden Zweck Berechtigung

/devices/{deviceId}/measurements/raw

GET

Messwerte eines Geräts

measurements:read

/devices/{deviceId}/measuringPoints

GET

Messpunkte eines Geräts

devices:read

/devices/{deviceId}/events

GET

Ereignisse eines Geräts, neueste zuerst

events:read

/rules

GET, POST

Regeln auflisten, Regel anlegen

rules:read, rules:write

/rules/{ruleId}

GET, PUT, DELETE

Regel lesen, ersetzen oder löschen

rules:read, rules:write, rules:delete

Messwerte

Parameter Beschreibung

measurement

Kommagetrennte Namen von Messpunkten. Ohne diesen Parameter liefert die API alle Messpunkte.

from, to

Zeitraum in RFC 3339, beide Grenzen eingeschlossen. Der Zeitraum umfasst höchstens 7 Tage.

sortOrder

asc oder desc.

pageSize

Werte je Seite, höchstens 10.000.

cursor, asOf

Mit der nächsten Seite fortfahren. Beide Werte aus der vorherigen Antwort mit derselben sortOrder verwenden.

Ereignisse

Parameter Beschreibung

from, to

Zeitraum in RFC 3339.

severity

warning oder error.

measuringPoint

Name des Messpunkts.

pageSize

Ereignisse je Seite, höchstens 100.

cursor, asOf

Mit der nächsten Seite fortfahren.

Regeln

Eine Regel hat einen Namen, eine Regeldefinition, einen Messpunkt, die Geräte und Parameter. Regeldefinitionen: upper_bound, lower_bound, jump, static_tolerance_check und trend. Die Bedeutung der Parameter beschreibt Funktionsweise von Regeln.

Listenparameter: page, pageSize (höchstens 100), sortBy, sortOrder, filter, search.

Fehler

{
  "code": "ERR_VALIDATION",
  "message": "human-readable message"
}

MCP-Server

https://<sot-host>/cm/api/v1/tenants/{tenantId}/mcp
Tool Zweck Berechtigung

sot-condition-monitoring_list_device_measuring_points

Messpunkte eines Geräts

devices:read

sot-condition-monitoring_query_measurements

Messwerte eines Geräts; höchstens 10.000 Werte je Seite, höchstens 7 Tage

measurements:read

sot-condition-monitoring_list_device_events

Ereignisse eines Geräts mit Filtern

events:read

sot-condition-monitoring_query_rules

Regeln auflisten oder eine Regel lesen

rules:read

sot-condition-monitoring_manage_rules

Regel für 1 bis 50 Geräte anlegen oder ersetzen

rules:write

sot-condition-monitoring_delete_rules

Regel löschen

rules:delete

Die Tools erwarten die UUID des Geräts. Mit sot-mdm_query_devices lässt sie sich ermitteln. Das Messwert-Tool liefert Rohwerte; es berechnet keine Statistiken.

Diese Seite bearbeiten Edit this page

Feedback on this pageFeedback zu dieser Seite