Eine Liste von Benachrichtigungen inkrementell abrufen
Diese API ermöglicht das inkrementelle Abrufen einer Liste von Benachrichtigungen. Dies ermöglicht schnelle Aktualisierungen von Benachrichtigungen, während sie erstellt, geändert oder gelöscht werden, ohne die vollständige Liste abrufen zu müssen.
Funktionsweise
Um eine Liste von Benachrichtigungen inkrementell abzurufen, wird das Feld SequenceNumber verwendet. Dieses Feld ist monoton aufsteigend, was bedeutet, dass beim Erstellen, Ändern oder Löschen einer Benachrichtigung ihr SequenceNumber-Feld auf einen höheren Wert als bei jeder anderen Benachrichtigung geändert wird. Dies ermöglicht das Abrufen von Daten basierend auf der SequenceNumber in kleinen Stapeln, bis keine weiteren Daten mehr abgerufen werden, und dann periodisch fortzufahren, um Aktualisierungen zu erhalten. Wenn das Ergebnis dieser API eine leere Liste ist, bedeutet dies, dass derzeit keine Aktualisierungen vorhanden sind.
Typischerweise verwendet eine Anwendung, die diese API nutzt, den folgenden Ablauf:
- Die Anwendung startet mit einer gespeicherten SequenceNumber (typischerweise in einem nichtflüchtigen Speicher). Bei der ersten Ausführung ist dieser Wert 1.
- Die Anwendung führt die API mit (gespeicherte SequenceNumber + 1) aus.
- Die Anwendung empfängt eine Liste von Benachrichtigungen, sortiert nach SequenceNumber.
- Wenn die empfangene Liste leer ist, wartet die Anwendung einige Sekunden und kehrt zu Schritt 2 zurück.
- Wenn die empfangene Liste nicht leer ist, speichert die Anwendung die höchste empfangene SequenceNumber.
- Die Anwendung kehrt sofort zu Schritt 2 zurück.
- Wenn eine neue Benachrichtigung erstellt oder eine bestehende geändert wird, ändert sich ihre SequenceNumber sofort auf einen höheren Wert als die zuletzt empfangene, sodass ihre Informationen sofort bei der nächsten Ausführung empfangen werden.
- Jedes empfangene Element mit der Eigenschaft Enabled auf false zeigt an, dass das Element gelöscht wurde. Wenn die Eigenschaft Enabled true ist, zeigt dies an, dass das Element gerade erstellt oder geändert wurde.
| In the flow above, it is assumed that the application always executes the API with the same set of clientID, facilityID, deviceID, and endpointID parameters. If different parameters are desired, the search must start from zero. |
|---|
| For debugging any application using this API, it is recommended to use maxCount = 1, to receive updates one at a time. This parameter can later be changed to a more practical value for production, such as 50. |
|---|
Anfrage
GET /api/v2/alerts/incremental/{sequenceNumber}?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={endpointID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}Parameter
| Name | Description |
|---|---|
| accessToken | Access token with permissions to read alert information. See this page for more information. The access token can also be sent as part of the query string, using the "accessToken" parameter. |
| sequenceNumber | Value of the SequenceNumber field from the last alert received. Use 0 to start from the beginning. |
| clientID | Optional identifier indicating that only alerts for the given client should be retrieved. |
| facilityID | Optional identifier indicating that only alerts for the given facility should be retrieved. |
| deviceID | Optional identifier indicating that only alerts for the given device should be retrieved. |
| endpointID | Optional identifier indicating that only alerts for the given endpoint should be retrieved. |
| maxCount | Optional parameter indicating the maximum number of alerts to include in the result. |
| It is mandatory to include one (and only one) of the parameters "clientID", "facilityID", "deviceID", or "endpointID". |
|---|
Antwort
Die Antwort enthält die Liste der übereinstimmenden Benachrichtigungen, wie in diesem Beispiel gezeigt:
[
{
"AlertID": 211,
"VariableTypeID": 1,
"EndpointID": 114092,
"ConditionType": 3,
"Threshold": 25,
"ClientID": 4,
"FacilityID": 184,
"NormalConditionType": 6,
"NormalThreshold": 24,
"MinimumDurationSeconds": 300,
"NotificationEmails": ["someone@somewhere.com"],
"NotificationSMSNumbers": ["+1123456789"],
"NotificationVoiceNumbers": ["+1123456789"],
"Tags": ["default", "gateway-default"],
"SequenceNumber": 45701485,
"Enabled": true,
"Schedules": [],
"Timezone": {
"CurrentOffsetMinutes": -180,
"TimeZoneCode": "america/argentina/buenos_aires"
}
},
{
"AlertID": 212,
"VariableTypeID": 1,
"EndpointID": 114092,
"ConditionType": 5,
"Threshold": 20,
"ClientID": 4,
"FacilityID": 184,
"NormalConditionType": 3,
"NormalThreshold": 22,
"MinimumDurationSeconds": 300,
"NotificationEmails": ["someone@somewhere.com"],
"NotificationSMSNumbers": ["+1123456789"],
"NotificationVoiceNumbers": ["+1123456789"],
"Tags": ["default", "gateway-default"],
"SequenceNumber": 45701485,
"Enabled": true,
"Schedules": [
{
"Days": [
1,
2,
4,
5
],
"StartTime": {
"Hour": 0,
"Millisecond": 0,
"Minute": 0,
"Second": 0
},
"EndTime": {
"Hour": 23,
"Millisecond": 999,
"Minute": 0,
"Second": 59
}
}
],
"Timezone": {
"CurrentOffsetMinutes": -180,
"TimeZoneCode": "america/argentina/buenos_aires"
}
}
]Eine Liste von Warnungen anhand von Parametern abrufen
This API allows retrieving a list of alerts using parameters. Request GET...
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...