Sidebar
fr:manual:api:reference:correlation:get
Table of Contents
correlation.get
Description
integer/array correlation.get(object parametres)
La méthode permet de récupérer des corrélations en fonction des paramètres spécifiés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| correlationids | string/array | Renvoie uniquement les corrélations avec les identifiants spécifiés. |
| selectFilter | query | Renvoie le filtre de corrélation dans la propriété filter. |
| selectOperations | query | Renvoie les opérations de corrélation dans la propriété operations. |
| sortfield | string/array | Trier le résultat par les propriétés spécifiées. Valeurs possibles: correlationid, name et status. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes “get”, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
Valeurs de retour
(integer/array) Retourne soit:
- un tableau d'objets;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupérer des corrélations
Récupérer toutes les corrélations configurées ainsi que les conditions et opérations de corrélation. Le filtre utilise le type d'évaluation “et/ou”, ainsi la propriété formula est vide et la propriété eval_formula est générée automatiquement.
Requête:
{ "jsonrpc": "2.0", "method": "correlation.get", "params": { "output": "extend", "selectOperations": "extend", "selectFilter": "extend" }, "auth": "343baad4f88b4106b9b5961e77437688", "id": 1 }
Réponse:
{ "jsonrpc": "2.0", "result": [ { "correlationid": "1", "name": "Correlation 1", "description": "", "status": "0", "filter": { "evaltype": "0", "formula": "", "conditions": [ { "type": "3", "oldtag": "error", "newtag": "ok", "formulaid": "A" } ], "eval_formula": "A" }, "operations": [ { "type": "0" } ] } ], "id": 1 }
Voir également
Source
CCorrelation::get() dans frontends/php/include/classes/api/services/CCorrelation.php.