Documentation
Table of Contents
Objeto de correlación
Los siguientes objetos están directamente relacionados con la API correlation.
Correlación
El objeto de correlación tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| correlationid | ID | ID de la correlación. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| name | cadena | Nombre de la correlación. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| description | cadena | Descripción de la correlación. |
| status | entero | Si la correlación está habilitada o deshabilitada. Valores posibles: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
Operación de correlación
El objeto de operación de correlación define una operación que será realiza cuando se ejecuta una correlación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | entero | Tipo de operación. Valores posibles: 0 - cerrar eventos antiguos; 1 - cerrar evento nuevo. Comportamiento de la propiedad: - obligatorio |
Filtro de correlación
El objeto de 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 | matriz | Conjunto de condiciones de filtro a utilizar para filtrar los resultados. Las condiciones se ordenarán según el orden en que se ubican en la fórmula. Comportamiento de la propiedad: - obligatorio |
| evaltype | entero | Método de evaluación de la condición del filtro. Valores posibles: 0 - y/o; 1 - y; 2 - o; 3 - expresión personalizada. Comportamiento de la propiedad: - obligatorio |
| eval_formula | cadena | 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 mediante su "formulaid". El valor de eval_formula es igual al valor de formula para filtros con una expresión personalizada.Comportamiento de la propiedad: - * sólo lectura* |
| formula | cadena | 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 mediante su "formulaid". Los ID utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: ninguna condición puede permanecer sin usar u omitir. Comportamiento de la propiedad:<br >- obligatorio si evaltype está configurado en "expresión personalizada" |
Condición del filtro de correlación
El objeto de condición del 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 | entero | Tipo de condición. Valores posibles: 0 - etiqueta de evento anterior; 1 - etiqueta de evento nueva; 2 - nuevo grupo de equipos de eventos; 3 - par de etiquetas de evento; 4 - valor de etiqueta de evento antiguo; 5 - valor de etiqueta de evento nuevo. Comportamiento de la propiedad:<br >- obligatorio |
| tag | cadena | Etiqueta de evento (antigua o nueva). Comportamiento de la propiedad: - obligatorio si type está configurado 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á configurado en "nuevo grupo anfitrión del evento" |
| oldtag | cadena | Etiqueta de evento antigua. Comportamiento de la propiedad: - obligatorio si type está configurado en "par de etiquetas de evento" " |
| newtag | cadena | Etiqueta de evento antigua. Comportamiento de la propiedad: - obligatorio si type está configurado en "par de etiquetas de evento " |
| value | cadena | Valor de etiqueta de evento (antiguo o nuevo). Comportamiento de la propiedad: - obligatorio si se establece type a "valor de etiqueta de evento antiguo" o "valor de etiqueta de evento nuevo" |
| formulaid | cadena | ID único arbitrario que se utiliza para hacer referencia a la condición desde una expresión personalizada. Sólo puede contener letras mayúsculas. El ID debe ser definido por el usuario al modificar las condiciones del filtro, pero se generará nuevamente al solicitarlas posteriormente. |
| operator | entero | Operador de condición. Comportamiento de la propiedad: - obligatorio si type está configurado en "nuevo grupo de equipos de eventos" ", "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, ver ejemplos en las páginas de los métodos correlation.get y correlation.create.
Los siguientes operadores y valores son compatibles con cada tipo de condición.
|Condición|Nombre de la condición|Operadores admitidos|Valor esperado| |---------|--------------|-------------------|---- ----------| |2|Grupo de equipos|=, <>|ID del grupo de equipos.| |4|Valor de etiqueta de evento anterior|=, <>, me gusta, no me gusta|cadena| |5|Nuevo valor de etiqueta de evento|=, <>, me gusta, no me gusta|cadena|