Table of Contents
> Correlatie-object
De volgende objecten zijn direct gerelateerd aan de correlatie API.
Correlatie
Het correlatie-object heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| correlationid | string | (alleen lezen) ID van de correlatie. |
| name (vereist) |
string | Naam van de correlatie. |
| description | string | Beschrijving van de correlatie. |
| status | integer | Of de correlatie is ingeschakeld of uitgeschakeld. Mogelijke waarden zijn: 0 - (standaard) ingeschakeld; 1 - uitgeschakeld. |
Houd er rekening mee dat voor sommige methoden (bijwerken, verwijderen) de vereiste/optionele parametercombinatie anders is.
Correlatiebewerking
Het correlatie bewerkings object definieert een bewerking die uitgevoerd wanneer een correlatie wordt uitgevoerd. Het heeft het volgende: eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |type
(vereist)|geheel getal|Type bewerking.
Mogelijke waarden:
0 - oude gebeurtenissen sluiten;
1 - nieuwe gebeurtenis sluiten.|
Correlatiefilter
Het correlatie filter object definieert een set voorwaarden die voldaan om de geconfigureerde correlatiebewerkingen uit te voeren. Het heeft de volgende eigenschappen.
|Property|Type|Beschrijving| |--------|---------------------------------------- -----------|-----------| |evaltype
(vereist)|geheel getal|Filterconditie-evaluatiemethode.
Mogelijke waarden:
0 - en/of;
1 - en;
2 - of;
3 - aangepaste uitdrukking.| |conditions
(vereist)|array|Set van filtervoorwaarden om te gebruiken voor het filteren van resultaten.| |eval_formula|string|(alleen-lezen) Gegenereerde expressie die zal worden gebruikt voor het evalueren van filtervoorwaarden. De expressie bevat ID's die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid. De waarde van eval_formula is gelijk aan de waarde van formula voor filters met een aangepaste expressie.| |formula|string|Door de gebruiker gedefinieerde expressie die moet worden gebruikt voor het evalueren van voorwaarden van filters met een aangepaste expressie. De expressie moet ID's bevatten die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid. De ID's die in de expressie worden gebruikt, moeten exact overeenkomen met de ID's die zijn gedefinieerd in de filtervoorwaarden: geen enkele voorwaarde mag ongebruikt blijven of worden weggelaten.
Vereist voor aangepaste expressie filters.|
Correlatie filtervoorwaarde
Het correlatie filtervoorwaarde-object definieert een specifieke voorwaarde die gecontroleerd moet worden voordat de correlatiebewerkingen worden uitgevoerd.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| type (vereist) |
integer | Type voorwaarde. Mogelijke waarden: 0 - oude gebeurtenistag; 1 - nieuwe gebeurtenistag; 2 - nieuwe gebeurtenis hostgroep; 3 - gebeurtenistag-paar; 4 - oude gebeurtenistag-waarde; 5 - nieuwe gebeurtenistag-waarde. |
| tag | string | Gebeurtenistag (oud of nieuw). Vereist wanneer het type voorwaarde is: 0, 1, 4, 5. |
| groupid | string | Hostgroep-ID. Vereist wanneer het type voorwaarde is: 2. |
| oldtag | string | Oude gebeurtenistag. Vereist wanneer het type voorwaarde is: 3. |
| newtag | string | Nieuwe gebeurtenistag. Vereist wanneer het type voorwaarde is: 3. |
| value | string | Gebeurtenistag (oud of nieuw) waarde. Vereist wanneer het type voorwaarde is: 4, 5. |
| formulaid | string | Willekeurige unieke ID die wordt gebruikt om te verwijzen naar de voorwaarde van een aangepaste expressie. Mag alleen hoofdletters bevatten. De ID moet door de gebruiker worden gedefinieerd bij het wijzigen van filtervoorwaarden, maar wordt opnieuw gegenereerd wanneer ze daarna worden opgevraagd. |
| operator | integer | Voorwaarde-operator. Vereist wanneer het type voorwaarde is: 2, 4, 5. |
Voor een beter begrip van hoe filters te gebruiken met diverse soorten expressies, zie de voorbeelden op de pagina's van de correlation.get en correlation.create methodes.
De volgende operators en waarden worden ondersteund voor elk type voorwaarde.
| Voorwaarde | Voorwaardenaam | Ondersteunde operators | Verwachte waarde |
|---|---|---|---|
| 2 | Hostgroep | =, <> | Hostgroep-ID. |
| 4 | Oude gebeurtenistag-waarde | =, <>, like, not like | string |
| 5 | Nieuwe gebeurtenistag-waarde | =, <>, like, not like | string |