Documentation
Table of Contents
correlation.get
Descripció
integer/array correlation.get(object parameters)
El mètode permet recuperar correlacions segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paràmetres
(objet) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| correlationids | ID/array | Retorna només correlacions amb els identificadors donats. |
| selectFilter | query | Retorna una propietat filtre amb la correlació de condicions. |
| selectOperations | query | Retorna una propietat operacions amb la correlació de condicions. |
| sortfield | string/array | Ordena el resultat segons les propietats donades. Els valors possibles són: rcorrelationid, name, status. |
| countOutput | boolean | Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar correlacions
Recupera totes les correlacions configurades juntament amb condicions i operacions. El filtre empra "i/o" tipus d'avaluació, pel que la propietat formula és buida i eval_formula es genera automàticament.
{
"jsonrpc": "2.0",
"method": "correlation.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend"
},
"id": 1
}Resposta:
{
"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
}Veieu també
Font
CCorrelation::get() in ui/include/classes/api/services/CCorrelation.php.