correlation.get

Descripción

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.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro	Tipo	Descripción
correlationids	cadena/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 operaciones con las operaciones de correlación.
sortfield	string/array	Ordena el resultado por las propiedades dadas. Valores posibles: `correlationid`, `name`, `status`.
countOutput	boolean	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
sortorderstartSearch	cadena/matriz
sortorder	booleano

Valores de retorno

(entero/matriz) Devuelve:

una matriz de objetos;
el recuento de objetos recuperados, si el parámetro countOutput ha 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 fórmula está vacía y se genera eval_formula automáticamente.

Solicitud:

{
       "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

CCorrelación::get() en ui/include/classes/api/services/CCorrelation.php.

Documentation