Documentation
Table of Contents
> Objet °ä´Ç°ù°ù¨¦±ô²¹³Ù¾±´Ç²Ô
Les objets suivants sont directement li¨¦s ¨¤ l'API correlation.
°ä´Ç°ù°ù¨¦±ô²¹³Ù¾±´Ç²Ô
L'objet corr¨¦lation a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| correlationid | string | (lecture seule) ID de la corr¨¦lation. |
| name (obligatoire) |
string | Nom de la corr¨¦lation. |
| 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. |
Notez que pour certaines m¨¦thodes (mise ¨¤ jour, suppression) la combinaison de param¨¨tres requise/optionnelle est diff¨¦rente.
Op¨¦ration de °ä´Ç°ù°ù¨¦±ô²¹³Ù¾±´Ç²Ô
L'objet op¨¦ration de corr¨¦lation d¨¦finit une op¨¦ration qui sera effectu¨¦e lorsqu'une corr¨¦lation est ex¨¦cut¨¦e. Il a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| type (obligatoire) |
integer | Type d'op¨¦ration. Valeurs possibles : 0 - fermer les anciens ¨¦v¨¨nements ; 1 - fermer le nouvel ¨¦v¨¨nement. |
Filtre de °ä´Ç°ù°ù¨¦±ô²¹³Ù¾±´Ç²Ô
L'objet filtre de corr¨¦lation d¨¦finit un ensemble de conditions ¨¤ respecter pour effectuer les op¨¦rations de corr¨¦lation configur¨¦es. Il a les propri¨¦t¨¦s suivantes.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| evaltype (obligatoire) |
integer | M¨¦thode d'¨¦valuation de la condition du filtre. Valeurs possibles : 0 - et/ou ; 1 - et ; 2 - ou ; 3 - expression personnalis¨¦e. |
| conditions (obligatoire) |
array | Ensemble de conditions de filtre ¨¤ utiliser pour filtrer les r¨¦sultats. |
| eval_formula | string | (lecture seule) Expression g¨¦n¨¦r¨¦e qui sera utilis¨¦e pour ¨¦valuer les conditions de filtrage. L'expression contient des ID qui r¨¦f¨¦rencent des conditions de filtrage sp¨¦cifiques par son formulaid. La valeur de eval_formula est ¨¦gale ¨¤ la valeur de formula pour les filtres avec une expression personnalis¨¦e. |
| 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 IDs qui r¨¦f¨¦rencent des conditions de filtrage sp¨¦cifiques par son formulaid. Les ID utilis¨¦s dans l'expression doivent correspondre exactement ¨¤ ceux d¨¦finis dans les conditions de filtrage : aucune condition ne peut rester inutilis¨¦e ou omise.Obligatoire pour les filtres d'expression personnalis¨¦s. |
Condition du 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 d'ex¨¦cuter les op¨¦rations de corr¨¦lation.
| ±Ê°ù´Ç±è°ù¾±¨¦³Ù¨¦ | Type | Description |
|---|---|---|
| type (obligatoire) |
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 tag d'¨¦v¨¦nement ; 4 - ancienne valeur de tag d'¨¦v¨¦nement ; 5 - nouvelle valeur de tag d'¨¦v¨¦nement. |
| tag | string | Tag d'¨¦v¨¦nement (ancienne ou nouvelle). Requis lorsque le type de condition est : 0, 1, 4, 5. |
| groupid | string | ID du groupe d'h?tes. Requis lorsque le type de condition est : 2. |
| oldtag | string | Ancien tag d'¨¦v¨¦nement. Requis lorsque le type de condition est : 3. |
| newtag | string | Nouveau tag d'¨¦v¨¦nement. Requis lorsque le type de condition est : 3. |
| value | string | Valeur du tag d'¨¦v¨¦nement (ancien ou nouveau). Requis lorsque le type de condition est : 4, 5. |
| formulaid | string | ID unique arbitraire utilis¨¦ pour r¨¦f¨¦rencer la condition ¨¤ partir d'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 filtrage, mais sera g¨¦n¨¦r¨¦ de nouveau lors d'une demande ult¨¦rieure. |
| operator | integer | Op¨¦rateur de condition. Requis lorsque le type de condition est : 2, 4, 5. |
Pour mieux comprendre comment utiliser des filtres avec diff¨¦rents types d¡¯expressions, voir des exemples sur les pages des m¨¦thodes correlation.get et correlation.create.
Les op¨¦rateurs et les 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 | =, <> | Host group ID. |
| 4 | Ancienne valeur de tag d'¨¦v¨¦nement | =, <>, like, not like | string |
| 5 | Nouvelle valeur de tag d'¨¦v¨¦nement | =, <>, like, not like | string |