event.acknowledge

Description

object event.acknowledge(object/array parameters)

Cette méthode vous 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.
  • Accuser réception de l'événement. Si l'événement est déjà accusé de réception, cette action sera ignorée.
  • Annuler l'accusé de réception de l'événement. Si l'événement n'est pas accusé de réception, cette action sera ignorée.
  • Ajouter un message.
  • Modifier la gravité de l'événement. Si l'événement a déjà la même gravité, cette action sera ignorée.
  • Supprimer la suppression de l'événement. Si l'événement est déjà supprimé, cette action sera ignorée.
  • Annuler la suppression de l'événement. Si l'événement n'est pas supprimé, cette action sera ignorée.
  • Modifier le rang de l'événement en cause. Si l'événement est déjà classé comme cause, cette action sera ignorée.
  • Modifier le rang de l'événement en symptôme. Si l'événement est déjà classé comme symptôme, cette action sera ignorée.

Seuls les événements de déclencheur peuvent être mis à jour.
Seuls les événements de problème peuvent être mis à jour.
Des droits de lecture/écriture sur le déclencheur sont requis pour fermer l'événement ou modifier sa gravité.
Pour fermer un événement, la fermeture manuelle doit être autorisée dans le déclencheur.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez Rôles utilisateur pour plus d'informations.

Paramètres

(object/array) Paramètres contenant les IDs des événements et des opérations de mise à jour à effectuer.

Parameter Type Description
eventids ID/array IDs des événements à acquitter.

Comportement du paramètre:
- required
action integer Action(s) de mise à jour de l'événement.

Valeurs bitmap possibles :
1 - fermer le problème ;
2 - acquitter l'événement ;
4 - ajouter un message ;
8 - modifier la gravité ;
16 - annuler l'acquittement de l'événement ;
32 - supprimer l'événement ;
64 - annuler la suppression de l'événement ;
128 - changer le rang de l'événement en cause ;
256 - changer le rang de l'événement en symptôme.

Il s'agit d'un champ de masque binaire ; toute somme des valeurs bitmap possibles est acceptable (par exemple, 34 pour acquitter et supprimer l'événement).

Comportement du paramètre:
- required
cause_eventid ID ID de l'événement en cause.

Comportement du paramètre:
- required si action contient le bit "changer le rang de l'événement en symptôme"
message string Texte du message.

Comportement du paramètre:
- required si action contient le bit "ajouter un message"
severity integer Nouvelle gravité pour les événements.

Valeurs possibles :
0 - non classé ;
1 - information ;
2 - avertissement ;
3 - moyen ;
4 - élevé ;
5 - catastrophe.

Comportement du paramètre:
- required si action contient le bit "modifier la gravité"
suppress_until integer Horodatage Unix jusqu'auquel l'événement doit être supprimé.

Si défini à "0", la suppression sera indéfinie.

Comportement du paramètre:
- required si action contient le bit "supprimer l'événement"

Valeurs de retour

(object) Renvoie un objet contenant les ID des événements mis à jour dans la propriété eventids.

Exemples

Accusé de réception d'un événement

Accusez réception d'un événement unique et laissez un message.

Requête:

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": "20427",
        "action": 6,
        "message": "Problème résolu."
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427"
        ]
    },
    "id": 1
}

Modification de la sévérité d'un événement

Modifiez la sévérité de plusieurs événements et laissez un message.

Requête :

{
    "jsonrpc": "2.0",
    "method": "event.acknowledge",
    "params": {
        "eventids": ["20427", "20428"],
        "action": 12,
        "message": "Maintenance required to fix it.",
        "severity": 4
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "eventids": [
            "20427",
            "20428"
        ]
    },
    "id": 1
}

Source

CEvent::acknowledge() dans ui/include/classes/api/services/CEvent.php.