Documentation
Table of Contents
> Obiekt Correlation =
Nast?puj?ce obiekty s? bezpo?rednio powi?zane z API correlation.
Correlation
Obiekt correlation posiada nast?puj?ce w?a?ciwo?ci.
| W?a?ciwo?? | Typ | Opis |
|---|---|---|
| correlationid | string | (tylko do odczytu) Identyfikator korelacji. |
| name (wymagane) |
string | Nazwa korelacji. |
| description | string | Opis korelacji. |
| status | integer | Czy korelacja jest w??czona czy wy??czona. Mo?liwe warto?ci to: 0 - (domy?lnie) w??czona; 1 - wy??czona. |
Nale?y zauwa?y?, ?e w przypadku niekt¨®rych metod (update, delete) wymagana/opcjonalna kombinacja parametr¨®w jest inna.
Correlation operation
Obiekt correlation operation definiuje operacj?, kt¨®ra b?dzie wykonana, kiedy wykonywana jest korelacja. Posiada nast?puj?ce w?a?ciwo?ci.
| W?a?ciwo?? | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ operacji. Mo?liwe warto?ci: 0 - zamknij stare zdarzenia; 1 - zamknij nowe zdarzenia. |
Correlation filter
Obiekt correlation filter definiuje zestaw warunk¨®w, kt¨®re musza by? spe?nione, aby wykona? skonfigurowane operacje korelacji. Posiada nast?puj?ce w?a?ciwo?ci.
| W?a?ciwo?? | Typ | Opis |
|---|---|---|
| evaltype (wymagane) |
integer | Metoda oceny warunk¨®w filtra. Mo?liwe warto?ci: 0 - i/lub; 1 - i; 2 - lub; 3 - wyra?enie niestandardowe. |
| conditions (wymagane) |
array | Zestaw warunk¨®w filtrowania u?ywnych do filtrowania wynik¨®w. |
| eval_formula | string | (tylko do odczytu) Wygenerowane wyra?enie, kt¨®re zostanie u?yte do oceny warunk¨®w filtra. Wyra?enie zawiera identyfikatory, kt¨®re odwo?uj? si? do okre?lonych warunk¨®w filtru za pomoc? formulaid. Warto?? eval_formula jest r¨®wna warto?ci formula dla filtr¨®w z wyra?eniem niestandardowym. |
| formula | string | Zdefiniowane przez u?ytkownika wyra?enie do oceny warunk¨®w filtr¨®w za pomoc? wyra?enia niestandardowego.. Wyra?enie musi zawiera? identyfikatory, kt¨®re odwo?uj? si? do okre?lonych warunk¨®w filtru za pomoc? ?formulaid¡±. Identyfikatory u?yte w wyra?eniu musz? dok?adnie odpowiada? identyfikatorom zdefiniowanym w warunkach filtra: ?aden warunek nie mo?e pozosta? nieu?ywany ani pomini?ty. Wymagany w przypadku filtr¨®w wyra?e¨½ niestandardowych. |
Correlation filter condition
Obiekt correlation filter condition definiuje okre?lony warunek, kt¨®ry nale?y sprawdzi? przed uruchomieniem operacji korelacji.
| W?a?ciwo?? | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ warunku. Mo?liwe warto?ci: 0 - stary znacznik zdarzenia; 1 - nowy znacznik zdarzenia; 2 - nowa grupa host¨®w zdarzenia; 3 - para znacznik¨®w zdarze¨½; 4 - stara warto?? znacznika zdarzenia; 5 - nowa warto?? znacznika zdarzenia. |
| tag | string | Znacznik zdarzenia (stary lub nowy). Wymagane, gdy typ warunku to: 0, 1, 4, 5. |
| groupid | string | OD grupy hosta. Wymagane, gdy typ warunku to: 2. |
| oldtag | string | Stary tag zdarzenia. Wymagane, gdy typ warunku to: 3. |
| newtag | string | Nowy tag zdarzenia. Wymagane, gdy typ warunku to: 3. |
| value | string | Warto?? tagu zdarzenia (stara lub nowa). Wymagane, gdy typ warunku to: 4, 5. |
| formulaid | string | Dowolny unikalny ID u?ywany do odniesienia si? do warunku z wyra?enia niestandardowego. Mo?e zawiera? tylko wielkie litery. Identyfikator musi zosta? zdefiniowany przez u?ytkownika podczas modyfikowania warunk¨®w filtrowania, ale zostanie wygenerowany ponownie, gdy za??da tego p¨®?niej. |
| operator | integerOperator warunku. Wymagane, gdy typ warunku to: 2, 4, 5. |
Aby lepiej zrozumie?, jak u?ywa? filtr¨®w z r¨®?nymi typami wyra?e¨½, zobacz przyk?ady na stronach metod correlation.get oraz correlation.create.
Nast?puj?ce operatory i warto?ci s? obs?ugiwane dla ka?dego typu warunku.
| Warunek | Nazwa warunku | Obs?ugiwane operatory | Warto?? oczekiwana |
|---|---|---|---|
| 2 | Grupa hosta | =, <> | ID grupy hosta. |
| 4 | Stara warto?? znacznika zdarzenia | =, <>, like, not like | string |
| 5 | Nowa warto?? znacznika zdarzenia | =, <>, like, not like | string |