Table of Contents
> Onderhoudsobject
De volgende objecten zijn direct gerelateerd aan de maintenance API.
Onderhoud
Het onderhoudsobject heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| maintenanceid | string | (alleen lezen) ID van het onderhoud. |
| name (vereist) |
string | Naam van het onderhoud. |
| active_since (vereist) |
timestamp | Tijd waarop het onderhoud actief wordt. De opgegeven waarde wordt naar beneden afgerond op minuten. |
| active_till (vereist) |
timestamp | Tijd waarop het onderhoud niet meer actief is. De opgegeven waarde wordt naar beneden afgerond op minuten. |
| description | string | Beschrijving van het onderhoud. |
| maintenance_type | integer | Type onderhoud. Mogelijke waarden: 0 - (standaard) met gegevensverzameling; 1 - zonder gegevensverzameling. |
| tags_evaltype | integer | Evaluatiemethode voor probleemtags. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of. |
Merk op dat voor sommige methoden (update, delete) de vereiste/optionele parametercombinatie anders is.
Tijdsperiode
Het tijdsperiode-object wordt gebruikt om perioden te definiëren waarin het onderhoud moet in werking treden. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| period | integer | Duur van de onderhoudsperiode in seconden. De opgegeven waarde wordt naar beneden afgerond op minuten. Standaard: 3600. |
| timeperiod_type | integer | Type tijdsperiode. Mogelijke waarden: 0 - (standaard) eenmalig; 2 - dagelijks; 3 - wekelijks;< br>4 - maandelijks. |
| start_date | timestamp | Datum waarop de onderhoudsperiode van kracht moet worden. Slechts voor één periode gebruikt. De opgegeven waarde wordt naar beneden afgerond op minuten. br>Standaard: huidige datum. |
| start_time | integer | Tijdstip waarop het onderhoud begint in seconden. Gebruikt voor dagelijkse, wekelijkse en maandelijkse perioden. De opgegeven waarde wordt naar beneden afgerond op minuten.<br > Standaard: 0. |
| every | integer | Gebruikt voor dagelijkse, wekelijkse en maandelijkse perioden. Voor dagelijkse en wekelijkse perioden definieert elke de dag- of weekintervallen waarop het onderhoud moet plaatsvinden.Standaard: 1. Voor maandelijkse perioden, als de eigenschap 'dayofweek' ten minste één geselecteerde dag van de week bevat, definieert de eigenschap 'every' de week van de maand waarin het onderhoud van kracht moet worden. <br >Mogelijke waarden: 1 - (standaard) eerste week; 2 - tweede week; 3 - derde week; 4 - vierde week; 5 - vorige week. |
| dayofweek | integer | Dagen van de week waarop het onderhoud van kracht moet worden. Dagen worden in binaire vorm opgeslagen, waarbij elk bit de corresponderende dag vertegenwoordigt. Bijvoorbeeld, 4 is binair gelijk aan 100 en betekent dat onderhoud op woensdag wordt ingeschakeld. Wordt gebruikt voor wekelijkse en maandelijkse perioden. Alleen vereist voor wekelijkse perioden. Er moet ten minste één 'dayofweek' of 'day' worden opgegeven voor maandelijkse perioden. |
| day | integer | Dag van de maand waarin het onderhoud van kracht moet worden. Alleen gebruikt voor maandelijkse perioden. Er moet ten minste één dayofweek of day worden opgegeven voor maandelijkse perioden. |
| maand | geheel getal | Maanden waarin het onderhoud van kracht moet worden. Maanden worden in binaire vorm opgeslagen, waarbij elk bit de corresponderende maand vertegenwoordigt. 5 is bijvoorbeeld binair gelijk aan 101 en betekent dat onderhoud in januari en maart wordt ingeschakeld. Alleen vereist voor maandelijkse perioden. |
Probleemtag
Het probleem tag-object wordt gebruikt om te definiëren welke problemen moeten worden onderdrukt wanneer het onderhoud van kracht wordt. Het heeft het volgende: eigendommen.
| Eigenschap | Type | Beschrijving |
|---|---|---|
| tag (verplicht) |
string | Naam van probleemtag. |
| operator | geheel getal | Conditie-operator. Mogelijke waarden: 0 - Is gelijk aan; 2 - (standaard) Bevat. |
| value | string | Waarde van probleemtag. |
Tags kunnen alleen worden opgegeven voor onderhoudsperiodes met gegevensverzameling ("maintenance_type":0`).