Documentation
Table of Contents
> Correlatie-object
De volgende objecten zijn direct gerelateerd aan de correlatie API.
Correlatie
Het correlatieobject heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| correlationid | string | ID van de correlatie. Eigenschapsgedrag: - alleen-lezen - vereist voor update-operaties |
| naam | string | Naam van de correlatie. Eigenschapsgedrag: - vereist voor aanmaak-operaties |
| omschrijving | string | Omschrijving van de correlatie. |
| status | integer | Of de correlatie ingeschakeld of uitgeschakeld is. Mogelijke waarden: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
Correlatiebewerking
Het correlatiebewerkingsobject definieert een bewerking die wordt uitgevoerd wanneer een correlatie wordt uitgevoerd. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| type | integer | Type bewerking. Mogelijke waarden: 0 - oude gebeurtenissen sluiten; 1 - nieuwe gebeurtenis sluiten. Eigenschapsgedrag: - vereist |
Correlatiefilter
Het correlatiefilterobject definieert een reeks voorwaarden die moeten worden voldaan om de geconfigureerde correlatiebewerkingen uit te voeren. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| evaltype | integer | Methode voor evaluatie van filtervoorwaarden. Mogelijke waarden: 0 - en/of; 1 - en; 2 - of; 3 - aangepaste expressie. Eigenschapsgedrag: - vereist |
| voorwaarden | array | Set van filtervoorwaarden die worden gebruikt voor het filteren van resultaten. Eigenschapsgedrag: - vereist |
| eval_formula | string | Gegenereerde expressie die wordt gebruikt voor het evalueren van filtervoorwaarden. De expressie bevat ID's die specifieke filtervoorwaarden aangeven aan de hand van de formulaid. De waarde van eval_formula is gelijk aan de waarde van formula voor filters met een aangepaste expressie.Eigenschapsgedrag: - alleen-lezen |
| formula | string | Aangepaste door de gebruiker gedefinieerde expressie die wordt gebruikt voor het evalueren van voorwaarden van filters met een aangepaste expressie. De expressie moet ID's bevatten die specifieke filtervoorwaarden aangeven aan de hand van de formulaid. De ID's die in de expressie worden gebruikt, moeten exact overeenkomen met degenen die zijn gedefinieerd in de filtervoorwaarden: geen enkele voorwaarde mag ongebruikt of weggelaten blijven.Eigenschapsgedrag: - vereist als evaltype is ingesteld op "aangepaste expressie" |
Correlatiefiltervoorwaarde
Het correlatiefiltervoorwaardeobject definieert een specifieke voorwaarde die moet worden gecontroleerd voordat de correlatiebewerkingen worden uitgevoerd.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| type | integer | Type voorwaarde. Mogelijke waarden: 0 - oude gebeurtenistag; 1 - nieuwe gebeurtenistag; 2 - nieuwe gebeurtenishostgroep; 3 - gebeurtenistagpaar; 4 - oude gebeurtenistagwaarde; 5 - nieuwe gebeurtenistagwaarde. Eigenschapsgedrag: - vereist |
| tag | string | Gebeurtenistag (oud of nieuw). Eigenschapsgedrag: - vereist als type is ingesteld op "oude gebeurtenistag", "nieuwe gebeurtenistag", "oude gebeurtenistagwaarde" of "nieuwe gebeurtenistagwaarde" |
| groupid | string | Hostgroep-ID. Eigenschapsgedrag: - vereist als type is ingesteld op "nieuwe gebeurtenishostgroep" |
| oldtag | string | Oude gebeurtenistag. Eigenschapsgedrag: - vereist als type is ingesteld op "gebeurtenistagpaar" |
| newtag | string | Oude gebeurtenistag. Eigenschapsgedrag: - vereist als type is ingesteld op "gebeurtenistagpaar" |
| value | string | Gebeurtenistagwaarde (oud of nieuw). Eigenschapsgedrag: - vereist als type is ingesteld op "oude gebeurtenistagwaarde" of "nieuwe gebeurtenistagwaarde" |
| formulaid | string | Willekeurige unieke ID die wordt gebruikt om naar de voorwaarde te verwijzen vanuit een aangepaste expressie. Kan alleen hoofdletters bevatten. De ID moet door de gebruiker worden gedefinieerd bij het wijzigen van filtervoorwaarden, maar wordt opnieuw gegenereerd bij het opvragen ervan nadien. |
| operator | integer | Voorwaarde-operator. Eigenschapsgedrag: - vereist als type is ingesteld op "nieuwe gebeurtenishostgroep", "oude gebeurtenistagwaarde" of "nieuwe gebeurtenistagwaarde" |
Voor een beter begrip van hoe filters met verschillende soorten expressies te gebruiken, zie voorbeelden op de pagina's van de methodes correlation.get en correlation.create.
De volgende operatoren en waarden worden ondersteund voor elk type voorwaarde.
| Voorwaarde | Voorwaarden-naam | Ondersteunde operatoren | Verwachte waarde |
|---|---|---|---|
| 2 | Hostgroep | =, <> | Hostgroep-ID. |
| 4 | Oude gebeurtenistagwaarde | =, <>, like, not like | string |
| 5 | Nieuwe gebeurtenistagwaarde | =, <>, like, not like | string |