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)
Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
Parámetro | Tipo | Descripción |
---|---|---|
correlationids | ID/array | Devolver solo correlaciones con los IDs dados. |
selectFilter | consulta | Devolver una propiedad filter con las condiciones de correlación. |
selectOperations | consulta | Devolver una propiedad operations con las operaciones de correlación. |
sortfield | string/array | Ordenar el resultado por las propiedades dadas. Valores posibles: correlationid , name , status . |
countOutput | booleano | Estos parámetros 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 | string/array | |
startSearch | booleano |
(entero/matriz)
Devuelve:
countOutput
ha sido usado.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 fórmula
está vacía y se genera eval_formula
automáticamente.
{
"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
}
CCorrelación::get() en ui/include/classes/api/services/CCorrelation.php.