API zur Überwachung (Systemwarnungen) - Automate_Evolve - Automate_Studio_Manager - Latest

Benutzerhandbuch zu Automate Evolve

Product type
Software
Portfolio
Integrate
Product family
Product
Automate > Automate Evolve
Automate > Automate Studio Manager
Version
Latest
Language
Deutsch
Product name
Automate Evolve
Title
Benutzerhandbuch zu Automate Evolve
Copyright
2024
First publish date
2018
ft:lastEdition
2024-05-23
ft:lastPublication
2024-05-23T16:24:42.750458

Die API zur Überwachung (Systemwarnungen) gibt Warnungen des Evolve Systems zurück (sofern vorhanden), die auf dem Administrations-Dashboard im Abschnitt Systemwarnungen angezeigt werden. Diese API verwendet die GET-Methode für die Rückgabe von Systemwarnungen.

Anforderungs- und Antworttext

Bei der Rückgabe von Evolve Systemwarnungen (sofern vorhanden), die im Abschnitt „Systemwarnungen“ des Administrations-Dashboards angezeigt werden, sind Anforderungen und Antworten wie folgt strukturiert:

Datenvertrag Anforderung:

Die API zur Überwachung (Systemwarnungen) benötigt keinen Anforderungstext. Der Benutzer muss auf die URL zugreifen, um die Liste der Benachrichtigungen abzurufen:

<Präfix-URL>/api/v1/Monitoring/SystemAlerts

Datenvertrag Antwort:

Die Antwort wird in folgendem Format zurückgegeben:

Name Typ Beschreibung
CreatedDate Datum UTC-Datumswert des Erstellungsdatums der Benachrichtigung im ISO-Format.
EnumNotificationScope Ganzzahl Sollte vom Benutzer ignoriert werden.
IsMessageLocalized Bit Sollte vom Benutzer ignoriert werden.
Nachricht Zeichenfolge

Nachrichtenwerte sind:

  1. Queue_Error: Ein Problem mit der MSMQ-Warteschlange.

  2. No_Reporting_Worker: Kein Worker mit Berichterstellungsfunktion zum Ausführen von Berichten gefunden.

  3. Machine_Down: Rechner (Evolve oder Worker-Setup) ist ausgefallen oder reagiert nicht.

  4. Optimize_Index: Optimierung des Evolve DB-Index erforderlich.

NotificationCategory Ganzzahl Weist stets Wert 1 auf (Systemwarnung)
NotificationId GUID Eindeutiger GUID-Wert dieser Benachrichtigung.
NotificationScope Ganzzahl

Wert gemäß Geltungsbereich der Benachrichtigung.

0 – Global.

1 – App.

NotificationState Ganzzahl Sollte vom Benutzer ignoriert werden.
NotificationType Ganzzahl Weist stets Wert 2 auf (d. h. Systemwarnung).
TeamspaceId GUID App-GUID-Wert (wenn die Benachrichtigung für eine bestimmte App gilt, d. h., wenn NotificationScope 1 ist; andernfalls wird eine leere GUID zurückgegeben).
UserID GUID Benutzer-GUID-Wert, wenn die Warnung für einen Evolve Benutzer spezifisch ist; andernfalls ist die GUID leer.
messageParameters JSON JSON-Wert mit weiteren Details zur Nachricht.

Anforderungs- und Antwortbeispiel:

Im folgenden Beispiel wird die Verwendung der API veranschaulicht:

Antwort

 {         "NotificationId": "4378ec0b-5365-4535-ab32-e104dd92f080",         "NotificationType": 2,         "Message": "Machine_Down",         "NotificationCategory": 1,         "UserId": "00000000-0000-0000-0000-000000000000",         "EnumNotificationScope": 0,         "TeamspaceId": "00000000-0000-0000-0000-000000000000",         "CreatedDate": "2021-06-20T10:56:23.803",         "NotificationScope": 0,         "NotificationState": 0,         "IsMessageLocalized": false,         "messageParameters": "[{\"id\":0,\"ParameterValue\":\"CHA-EN-VST679\"}]"     },     {         "NotificationId": "c6ae12c0-4e5c-4a1a-938b-fe120693932e",         "NotificationType": 2,         "Message": "Queue_Error",         "NotificationCategory": 1,         "UserId": "00000000-0000-0000-0000-000000000000",         "EnumNotificationScope": 0,         "TeamspaceId": "00000000-0000-0000-0000-000000000000",         "CreatedDate": "2021-07-12T10:37:12.273",         "NotificationScope": 0,         "NotificationState": 0,         "IsMessageLocalized": false,         "messageParameters": "[{\"id\":0,\"ParameterValue\":\"Host : CHA-EN-VST679 Queue : AutoRunFile\"}]"     },     {         "NotificationId": "938f852d-e113-487e-aad3-87f45d28dc68",         "NotificationType": 2,         "Message": "Queue_Error",         "NotificationCategory": 1,         "UserId": "00000000-0000-0000-0000-000000000000",         "EnumNotificationScope": 0,         "TeamspaceId": "00000000-0000-0000-0000-000000000000",         "CreatedDate": "2021-07-12T10:56:45.313",         "NotificationScope": 0,         "NotificationState": 0,         "IsMessageLocalized": false,         "messageParameters": "[{\"id\":0,\"ParameterValue\":\"Host : CHA-PLP41326 Queue : Reporting\"}]"     }...