L'API Monitoring (Alertes système) retourne les alertes système d'Evolve affichées dans la section Alertes système du tableau de bord d'administration. Cette API utilise la méthode GET pour retourner toutes les alertes système.
Corps de la requête et de la réponse
Pour retourner les alertes système d'Evolve (le cas échéant) affichées dans la section Alertes système du tableau de bord d'administration, la structure de la demande et de la réponse sera la suivante :
Demander les contrats de données :
L'API Monitoring (Alertes système) n'a pas besoin d'un corps de requête. L'utilisateur doit cliquer sur l'URL pour extraire la liste des Notifications :
<Prefix URL>/api/v1/Monitoring/SystemAlerts
Contrat de données de la réponse :
La réponse sera retournée au format suivant :
| Nom | Type | Description |
|---|---|---|
| CreatedDate | Date | Valeur de date UTC de la notification, date de création au format ISO. |
| EnumNotificationScope | Entier | Doit être ignoré par l'utilisateur. |
| IsMessageLocalized | Bit | Doit être ignoré par l'utilisateur. |
| Message | Chaîne |
Les valeurs du message sont les suivantes :
|
| NotificationCategory | Entier | Il a toujours la valeur 1 (Alerte système) |
| NotificationId | GUID | Valeur GUID unique de cette notification. |
| NotificationScope | Entier |
Valeur selon la portée de la Notification. 0 - Globale. 1- Application. |
| NotificationState | Entier | Doit être ignoré par l'utilisateur. |
| NotificationType | Entier | A toujours la valeur 2 (c'est-à-dire Avertissement système). |
| TeamspaceId | GUID | Valeur App GUI (si la notification concerne une application spécifique, lorsque NotificationScope a la valeur 1, par exemple. Sinon GUID vide est renvoyé). |
| UserId | GUID | Valeur GUID de l'utilisateur si l'alerte est spécifique à un utilisateur Evolve sinon GUID vide. |
| messageParameters | JSON | Valeur JSON avec plus de détails sur le message. |
Exemple de requête et de réponse
Les exemples ci-dessous illustrent l'utilisation de l'API :
Réponse
{ "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\"}]" }...