Sidebar
fr:manual:api:reference:event:acknowledge
Table of Contents
event.acknowledge
Description
object event.acknowledge(object/array parameters)
Cette méthode permet de mettre à jour des événements. Les actions de mise à jour suivantes peuvent être effectuées :
- Fermer l'événement. Si l'événement est déjà résolu, cette action sera ignorée.
- Acquitter l'événement. Si l'événement est déjà acquitté, cette action sera ignorée.
- Ajouter un message.
- Changer la sévérité de l'événement. Si l'événement a déjà la même sévérité, cette action sera ignorée.
Seuls les événements de déclencheurs peuvent être mis à jour.
Seuls les événements problématiques peuvent être mis à jour.
Des droits en lecture/écriture pour le déclencheur sont nécessaires pour fermer l'événement ou pour modifier sa sévérité.
Pour fermer un événement, cela doit être autorisé dans le déclencheur.
Seuls les événements problématiques peuvent être mis à jour.
Des droits en lecture/écriture pour le déclencheur sont nécessaires pour fermer l'événement ou pour modifier sa sévérité.
Pour fermer un événement, cela doit être autorisé dans le déclencheur.
Paramètres
(object/array) Paramètres contenant les identifiants des événements et les opérations de mise à jour à effectuer.
| Paramètre | Type | Description |
|---|---|---|
| eventids (obligatoire) | string/object | ID des événements à acquitter. |
| action (obligatoire) | integer | Action(s) de mise à jour des événements. Ce champ est un masque de bits, toute combinaison de valeurs est acceptable. Valeurs possibles : 1 - fermer le problème ; 2 - acquitter l'événement ; 4 - ajouter un message ; 8 - changer la sévérité. |
| message | string | Texte du message. Obligatoire, si l'action contient 'ajouter un message'. |
| severity | integer | Nouvelle sévérité des événements. Obligatoire, si l'action contient 'changer la sévérité'. Valeurs possibles : 0 - non classé ; 1 - information ; 2 - avertissement ; 3 - moyen ; 4 - haut ; 5 - désastre. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des événements mis à jour sous la propriété eventids.
Exemples
Acquittement d'un événement
Acquitter un événement et ajouter un message.
Requête :
{ "jsonrpc": "2.0", "method": "event.acknowledge", "params": { "eventids": "20427", "action": 6, "message": "Problem resolved." }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": { "eventids": [ "20427" ] }, "id": 1 }
Changement de sévérité d'un événement
Modifier la sévérité de plusieurs événements et ajouter un message.
Requête :
{ "jsonrpc": "2.0", "method": "event.acknowledge", "params": { "eventids": ["20427", "20428"], "action": 12, "message": "Maintenance required to fix it.", "severity": 4 }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": { "eventids": [ "20427", "20428" ] }, "id": 1 }
Source
CEvent::acknowledge() dans frontends/php/include/classes/api/services/CEvent.php.