Documentation
Table of Contents
correlation.get
Description
integer/array correlation.get(object parameters)
La m¨¦thode permet de r¨¦cup¨¦rer des corr¨¦lations en fonction des param¨¨tres sp¨¦cifi¨¦s.
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. Voir les r?les utilisateur pour plus d'informations.
±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ
(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.
La m¨¦thode prend en charge les param¨¨tres suivants.
| ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð | Type | Description |
|---|---|---|
| correlationids | string/array | Renvoie uniquement les corr¨¦lations avec les identifiants sp¨¦cifi¨¦s. |
| selectFilter | query | Renvoie les conditions de 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 en d¨¦tail dans la page des commentaires de r¨¦f¨¦rence. |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valeurs retourn¨¦es
(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¨¦ration 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 ui/include/classes/api/services/CCorrelation.php.