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 pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.

Parámetros

(object) 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 indicados.
selectFilter	query	Devolver una propiedad `filter` con las condiciones de correlación.
selectOperations	query	Devolver una propiedad `operations` con las operaciones de correlación.
sortfield	string/array	Ordenar el resultado por las propiedades indicadas. Valores posibles: `correlationid`, `name`, `status`.
countOutput	boolean	Estos parámetros se describen en el comentario de referencia.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valores de retorno

(integer/array) Devuelve:

un array de objetos;
el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar correlaciones

Recupera todas las correlaciones configuradas junto con las condiciones y operaciones de correlación. El filtro utiliza el tipo de evaluación "and/or", por lo que la propiedad formula está vacía y eval_formula se genera 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
       }

Véase también

Fuente

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

Documentation