Documentation
Table of Contents
> Objecte de correlació
Els següents objectes són relacionats amb l'API correlation.
Correlació
L'objecte de correlació té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| correlationid | string | (només lectura) ID de la correlació. |
| name (obligatori) |
string | Nom de la correlació. |
| description | string | Descripció de la correlació. |
| status | integer | Diu si la correlació és activa o desactivada. Els valors possibles són: 0 - (per defecte) actiu; 1 - desactivat. |
Veieu que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris o opcionals és diferent.
Operació de correlació
L'objecte d'operació de correlació defineix una operació que es durà a terme quan la correlació s'executi. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| type (obligatori) |
integer | Tipus d'operació. Valors possibles: 0 - tancar esdeveniments antics; 1 - tancar un nou esdeveniment. |
Filtre de correlació
L'objecte de filtre de correlació defineix el conjunt de condicions que s'han de complir per dur a terme les operacions de correlacions configurades. Té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| evaltype (obligatori) |
integer | Mètode d'avaluació de la condició del filtre. Valors acceptats: 0 - i/o; 1 - i; 2 - o; 3 - expressió a mida. |
| conditions (obligatori) |
array | Conjunt de condicions de filtre a emprar per filtrar els resultats. |
| eval_formula | string | (només lectura) Expressió generada que s'emprarà per avaluar les condicions de filtrat. L'expressió conté els ID que referencien les condicions de filtrat específiques per la seva formulaid. El valor d'eval_formula equival al valor de formula per als filtres amb expressions a mida. |
| formula | string | Expressió definida per l'usuari a emprar per avaluar les condicions dels filtres amb una expressió personalitzada. L'expressió ha de contindre els IDs que referencien les condicions de filtrat específiques per a la seva formulaid. Els IDs emprats a l'expressió han de correspondre als definits per les condicions de filtrat: cap condició no pot pas restar sense ús o omesa.Obligatori per els filtres d'expressió personalitzats. |
Condició del filtre de correlació
L'objecte de condició de filtre de correlació defineix una condició específica que s'ha de verificar abans d'executar les operacions de correlació.
| Propietat | Tipus | Descripció |
|---|---|---|
| type (obligatori) |
integer | Tipus de condició. Valors possibles: 0 - tag d'esdeveniment antic; 1 - tag d'esdeveniment nou; 2 - nou esdeveniment de grup d'equips; 3 - parell de tag d'esdeveniment; 4 - valor antic de tag d'esdeveniment; 5 - valor nou de tag d'esdeveniment. |
| tag | string | Tag d'esdeveniment (antic o nou). Obligatori quan el tipus de condició sigui: 0, 1, 4, 5. |
| groupid | string | ID del grup d'equips. Obligatori quan el tipus de condició sigui : 2. |
| oldtag | string | Tag d'esdeveniment antic. Obligatori quan el tipus de condició sigui: 3. |
| newtag | string | Tag d'esdeveniment nou. Obligatori quan el tipus de condició sigui: 3. |
| value | string | Valor de tag d'esdeveniment (antic o nou). Obligatori quan el tipus de condició sigui: 4, 5. |
| formulaid | string | ID únic arbitrari emprat per referenciar la condició a partir d'una expressió personalitzada. No pot pas contindre lletres majúscules. L'ID ha d'ésser definit per l'usuari quan es modifiquin les condicions de filtrat, però haurà de generar-se de nou quan hi hagi una petició posterior.. |
| operator | integer | Operador de condició. Obligatori quan el tipus de condició sigui: 2, 4, 5. |
Per entendre millor com fer anar els filtres amb diferents tipus d'expressions, veieu els exemples a les pàgines dels mètodes correlation.get i correlation.create.
Les operacions i valors següents són suportats per cada tipus de condició.
| Condició | Nom de condició | Operadors suportats | Valor esperat |
|---|---|---|---|
| 2 | Grup d'equips | =, <> | ID del grup d'equips. |
| 4 | Valor de tag d'esdeveniment antic | =, <>, like, not like | string |
| 5 | Valor de tag d'esdeveniment nou | =, <>, like, not like | string |