Les objets suivants sont directement liés à l'API correlation.

Corrélation

L'objet de corrélation possède les propriétés suivantes.

Propriété Type Description
correlationid ID ID de la corrélation.

Comportement de la propriété :
- lecture seule
- requis pour les opérations de mise à jour
name string Nom de la corrélation.

Comportement de la propriété :
- requis pour les opérations de création
description string Description de la corrélation.
status integer Indique si la corrélation est activée ou désactivée.

Valeurs possibles :
0 - (par défaut) activée ;
1 - désactivée.

Opération de corrélation

L'objet d'opération de corrélation définit une opération qui sera effectuée lorsqu'une corrélation est exécutée. Il possède les propriétés suivantes.

Propriété Type Description
type integer Type d'opération.

Valeurs possibles :
0 - fermer les anciens événements ;
1 - fermer le nouvel événement.

Comportement de la propriété :
- obligatoire

Filtre de corrélation

L’objet de filtre de corrélation définit un ensemble de conditions qui doivent être remplies pour exécuter les opérations de corrélation configurées. Il possède les propriétés suivantes.

Propriété Type Description
conditions array Ensemble de conditions de filtre à utiliser pour filtrer les résultats. Les conditions seront triées dans l’ordre de leur placement dans la formule.

Comportement de la propriété :
- obligatoire
evaltype integer Méthode d’évaluation des conditions du filtre.

Valeurs possibles :
0 - Et/Ou ;
1 - Et ;
2 - Ou ;
3 - Expression personnalisée.

Comportement de la propriété :
- obligatoire
eval_formula string Expression générée qui sera utilisée pour évaluer les conditions du filtre. L’expression contient des ID qui font référence à des conditions de filtre spécifiques via leur formulaid. La valeur de eval_formula est égale à la valeur de formula pour les filtres avec une expression personnalisée.

Comportement de la propriété :
- lecture seule
formula string Expression définie par l’utilisateur à utiliser pour évaluer les conditions des filtres avec une expression personnalisée. L’expression doit contenir des ID qui font référence à des conditions de filtre spécifiques via leur formulaid. Les ID utilisés dans l’expression doivent correspondre exactement à ceux définis dans les conditions du filtre : aucune condition ne peut rester inutilisée ou omise.

Comportement de la propriété :
- obligatoire si evaltype est défini sur « custom expression »

Condition de filtre de corrélation

L'objet de condition de filtre de corrélation définit une condition spécifique qui doit être vérifiée avant l'exécution des opérations de corrélation.

Propriété Type Description
type integer Type de condition.

Valeurs possibles :
0 - ancien tag d'événement ;
1 - nouveau tag d'événement ;
2 - nouveau groupe d'hôtes de l'événement ;
3 - paire de tags d'événement ;
4 - valeur de l'ancien tag d'événement ;
5 - valeur du nouveau tag d'événement.

Comportement de la propriété :
- obligatoire
tag string Tag d'événement (ancien ou nouveau).

Comportement de la propriété :
- obligatoire si type est défini sur « ancien tag d'événement », « nouveau tag d'événement », « valeur de l'ancien tag d'événement » ou « valeur du nouveau tag d'événement »
groupid ID ID du groupe d'hôtes.

Comportement de la propriété :
- obligatoire si type est défini sur « nouveau groupe d'hôtes de l'événement »
oldtag string Ancien tag d'événement.

Comportement de la propriété :
- obligatoire si type est défini sur « paire de tags d'événement »
newtag string Ancien tag d'événement.

Comportement de la propriété :
- obligatoire si type est défini sur « paire de tags d'événement »
value string Valeur du tag d'événement (ancien ou nouveau).

Comportement de la propriété :
- obligatoire si type est défini sur « valeur de l'ancien tag d'événement » ou « valeur du nouveau tag d'événement »
formulaid string ID unique arbitraire utilisé pour référencer la condition depuis une expression personnalisée. Ne peut contenir que des lettres majuscules. L'ID doit être défini par l'utilisateur lors de la modification des conditions de filtre, mais sera généré à nouveau lors de leur demande ultérieure.
operator integer Opérateur de condition.

Comportement de la propriété :
- obligatoire si type est défini sur « nouveau groupe d'hôtes de l'événement », « valeur de l'ancien tag d'événement » ou « valeur du nouveau tag d'événement »

Pour mieux comprendre comment utiliser les filtres avec différents types d'expressions, consultez les exemples dans les pages des méthodes correlation.get et correlation.create.

Les opérateurs et valeurs suivants sont pris en charge pour chaque type de condition.

Condition Nom de la condition Opérateurs pris en charge Valeur attendue
2 Groupe d'hôtes =, <> ID du groupe d'hôtes.
4 Valeur de l'ancien tag d'événement =, <>, like, not like string
5 Valeur du nouveau tag d'événement =, <>, like, not like string