Documentation
Table of Contents
correlation.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array correlation.get(object parameters)
El m¨¦todo permite recuperar correlaciones seg¨²n los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se pueden revocar en la configuraci¨®n de roles de usuario. Ver Roles de usuario para m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(objeto) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| correlationids | ID/matriz | Devuelve solo correlaciones con los ID proporcionados. |
| selectFilter | query | Devuelve una propiedad filter con las condiciones de correlaci¨®n. |
| selectOperations | query | Devuelve una propiedad operations con las operaciones de correlaci¨®n. |
| sortfield | cadena/matriz | Ordena el resultado seg¨²n las propiedades dadas. Valores posibles: correlationid, name, status. |
| countOutput | booleano | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el par¨¢metro
countOutputha sido usado.
Ejemplos
Recuperar correlaciones
Recuperar todas las correlaciones configuradas junto con las condiciones y operaciones de la correlaci¨®n. El filtro utiliza el tipo de evaluaci¨®n "y/o", entonces la propiedad ´Ú¨®°ù³¾³Ü±ô²¹ est¨¢ vac¨ªa y se genera eval_formula ²¹³Ü³Ù´Ç³¾¨¢³Ù¾±³¦²¹³¾±ð²Ô³Ù±ð.
{
"jsonrpc": "2.0",
"method": "correlation.get",
"params": {
"output": "extend",
"selectOperations": "extend",
"selectFilter": "extend"
},
"id": 1
}Respuesta:
{
"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
}Ver tambi¨¦n
Fuente
C°ä´Ç°ù°ù±ð±ô²¹³¦¾±¨®²Ô::get() en ui/include/classes/api/services/CCorrelation.php.