Table of Contents
Objeto correlación
Los siguientes objetos están directamente relacionados con la API de correlación.
Correlación
El objeto correlación tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| correlationid | ID | ID de la correlación. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| name | string | Nombre de la correlación. Comportamiento de la propiedad: - requerido para operaciones de creación |
| description | string | Descripción de la correlación. |
| status | integer | Indica si la correlación está habilitada o deshabilitada. Valores posibles: 0 - (por defecto) habilitada; 1 - deshabilitada. |
Operación de correlación
El objeto de operación de correlación define una operación que se realizará cuando se ejecute una correlación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | integer | Tipo de operación. Valores posibles: 0 - cerrar eventos antiguos; 1 - cerrar nuevo evento. Comportamiento de la propiedad: - obligatorio |
Filtro de correlación
El objeto filtro de correlación define un conjunto de condiciones que deben cumplirse para realizar las operaciones de correlación configuradas. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| conditions | array | Conjunto de condiciones de filtro a utilizar para filtrar los resultados. Las condiciones se ordenarán en el orden de su colocación en la fórmula. Comportamiento de la propiedad: - requerido |
| evaltype | integer | Método de evaluación de la condición de filtro. Valores posibles: 0 - y/o; 1 - y; 2 - o; 3 - expresión personalizada. Comportamiento de la propiedad: - requerido |
| eval_formula | string | Expresión generada que se utilizará para evaluar las condiciones del filtro. La expresión contiene IDs que hacen referencia a condiciones de filtro específicas por su formulaid. El valor de eval_formula es igual al valor de formula para los filtros con una expresión personalizada.Comportamiento de la propiedad: - solo lectura |
| formula | string | Expresión definida por el usuario que se utilizará para evaluar las condiciones de los filtros con una expresión personalizada. La expresión debe contener IDs que hagan referencia a condiciones de filtro específicas por su formulaid. Los IDs utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: ninguna condición puede quedar sin usar u omitida.Comportamiento de la propiedad: - requerido si evaltype está establecido en "expresión personalizada" |
Condición de filtro de correlación
El objeto de condición de filtro de correlación define una condición específica que debe comprobarse antes de ejecutar las operaciones de correlación.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | integer | Tipo de condición. Valores posibles: 0 - etiqueta de evento anterior; 1 - etiqueta de evento nueva; 2 - grupo de equipos del evento nuevo; 3 - par de etiquetas de evento; 4 - valor de etiqueta de evento anterior; 5 - valor de etiqueta de evento nuevo. Comportamiento de la propiedad: - obligatorio |
| tag | string | Etiqueta de evento (anterior o nueva). Comportamiento de la propiedad: - obligatorio si type está establecido en "etiqueta de evento anterior", "etiqueta de evento nueva", "valor de etiqueta de evento anterior" o "valor de etiqueta de evento nuevo" |
| groupid | ID | ID del grupo de equipos. Comportamiento de la propiedad: - obligatorio si type está establecido en "grupo de equipos del evento nuevo" |
| oldtag | string | Etiqueta de evento anterior. Comportamiento de la propiedad: - obligatorio si type está establecido en "par de etiquetas de evento" |
| newtag | string | Etiqueta de evento anterior. Comportamiento de la propiedad: - obligatorio si type está establecido en "par de etiquetas de evento" |
| value | string | Valor de la etiqueta de evento (anterior o nueva). Comportamiento de la propiedad: - obligatorio si type está establecido en "valor de etiqueta de evento anterior" o "valor de etiqueta de evento nuevo" |
| formulaid | string | ID único arbitrario que se utiliza para referenciar la condición desde una expresión personalizada. Solo puede contener letras mayúsculas. El ID debe ser definido por el usuario al modificar las condiciones del filtro, pero se generará uno nuevo al solicitarlas posteriormente. |
| operator | integer | Operador de condición. Comportamiento de la propiedad: - obligatorio si type está establecido en "grupo de equipos del evento nuevo", "valor de etiqueta de evento anterior" o "valor de etiqueta de evento nuevo" |
Para comprender mejor cómo utilizar los filtros con varios tipos de expresiones, consulte los ejemplos en las páginas de los métodos correlation.get y correlation.create.
Se admiten los siguientes operadores y valores para cada tipo de condición.
| Condición | Nombre de la condición | Operadores soportados | Valor esperado |
|---|---|---|---|
| 2 | Grupo de equipos | =, <> | ID del grupo de equipos. |
| 4 | Valor de etiqueta de evento anterior | =, <>, like, not like | string |
| 5 | Valor de etiqueta de evento nuevo | =, <>, like, not like | string |