Zum Hauptinhalt springen

Einführung

Schnellstart Grundlegende Konzepte

Konfiguration

Globale Konfiguration

Kundenkonfiguration

Allgemeine Wartung

Verwendung

Datenextraktions-APIs

Alarm-Datentyp Einen Alarm anhand seiner ID abrufen Eine Liste von Alarmen anhand von Parametern abrufen Eine Liste von Alarmen inkrementell abrufen

Persistente Access Tokens Instanz-Mapping-API

Low-Code-Tools (Skripting)

Referenz

Anforderungen und Best Practices

Implementierungen

Neuigkeiten

Versionshinweise

Datenextraktions-APIs Alarme

Alarm-Datentyp

Einführung

Der Alarm-Datentyp ermöglicht das Abrufen von Alarm-Informationen. Im Folgenden finden Sie alle Eigenschaften des Alarm-Datentyps.

Eigenschaften

AlarmID (int) Die Eigenschaft AlarmID stellt den eindeutigen Bezeichner des Alarms in der Plattform dar. Dieser Bezeichner wird automatisch zugewiesen, wenn ein Alarm erstellt wird. ### DeviceID (int) Die Eigenschaft DeviceID stellt den eindeutigen Bezeichner des Geräts dar, das den Alarm auslöst. ### EndpointID (int) Eindeutiger Bezeichner des Endpunkts, dem die Benachrichtigung entspricht. ### AlarmTypeID (int) Die Eigenschaft AlarmTypeID gibt den Typ des Alarms an. ### AlarmTypeDescription (string) Beschreibung des Alarm-Typs. Wird nur für Auflistungen oder Aufzählungen verwendet. ### AlarmSeverityID (int)

Gibt den Schweregrad des Alarms an. Entspricht einem der folgenden Werte:

Information = 0: Informativ, kein Schweregrad;
Low = 1: Niedriger Alarm-Schweregrad;
Medium = 2: Mittlerer Schweregrad;
High = 3: Kritischer Alarm, hoher Schweregrad.

AlarmSeverityDescription (string) Beschreibung des Alarm-Schweregrads. ### Details (string) Mit dem Alarm verbundene Details. ### DateTimeCreated_UTC (string) Datum und Uhrzeit der Alarm-Erstellung (UTC) im String-Format. ### DateTimeClosed_UTC (string) Datum und Uhrzeit der Alarm-Schließung (UTC) im String-Format. ### SequenceNumber (long) Sequenznummer, die dem Alarm zugeordnet ist. Die Sequenznummer wird bei jeder Änderung des Alarms mit einer höheren Nummer aktualisiert, einschließlich der Schließung. Jedem Alarm wird garantiert eine höhere Nummer als allen anderen zugewiesen.

Alarme

Introduction This section explains how to extract the definition of alarms generated from alerts in the Gear Studio platform, using the data extraction API. These...

Einen Alarm anhand seiner ID abrufen

This API allows retrieving an alarm by its ID. Request GET /api/v2/alarms/{alarmID} HTTP/1.1 Host: gear.cloud.studio Authorization: Bearer {accessToken}...

Auf dieser Seite

Einführung Eigenschaften AlarmID (int) Die Eigenschaft AlarmID stellt den eindeutigen Bezeichner des Alarms in der Plattform dar. Dieser Bezeichner wird automatisch zugewiesen, wenn ein Alarm erstellt wird. ### DeviceID (int) Die Eigenschaft DeviceID stellt den eindeutigen Bezeichner des Geräts dar, das den Alarm auslöst. ### EndpointID (int) Eindeutiger Bezeichner des Endpunkts, dem die Benachrichtigung entspricht. ### AlarmTypeID (int) Die Eigenschaft AlarmTypeID gibt den Typ des Alarms an. ### AlarmTypeDescription (string) Beschreibung des Alarm-Typs. Wird nur für Auflistungen oder Aufzählungen verwendet. ### AlarmSeverityID (int)AlarmSeverityDescription (string) Beschreibung des Alarm-Schweregrads. ### Details (string) Mit dem Alarm verbundene Details. ### DateTimeCreated_UTC (string) Datum und Uhrzeit der Alarm-Erstellung (UTC) im String-Format. ### DateTimeClosed_UTC (string) Datum und Uhrzeit der Alarm-Schließung (UTC) im String-Format. ### SequenceNumber (long) Sequenznummer, die dem Alarm zugeordnet ist. Die Sequenznummer wird bei jeder Änderung des Alarms mit einer höheren Nummer aktualisiert, einschließlich der Schließung. Jedem Alarm wird garantiert eine höhere Nummer als allen anderen zugewiesen.