Documentation
Table of Contents
> Objecte de correlaci¨®
Els seg¨¹ents objectes s¨®n relacionats amb l'API correlation.
°ä´Ç°ù°ù±ð±ô²¹³¦¾±¨®
L'objecte de correlaci¨® t¨¦ les propietats seg¨¹ents:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| correlationid | string | (nom¨¦s lectura) ID de la correlaci¨®. |
| name (obligatori) |
string | Nom de la correlaci¨®. |
| description | string | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| 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. |
°ä´Ç²Ô»å¾±³¦¾±¨® 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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| 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¨®.
| °ä´Ç²Ô»å¾±³¦¾±¨® | 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 |