Documentation
Table of Contents
> Onderhoudsobject
De volgende objecten zijn direct gerelateerd aan de maintenance API.
Onderhoud
Het onderhoudsobject heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| maintenanceid | string | ID van het onderhoud. Gedrag van eigenschap: - alleen-lezen - vereist voor update-operaties |
| name | string | Naam van het onderhoud. Gedrag van eigenschap: - vereist voor aanmaakoperaties |
| active_since | timestamp | Tijd waarop het onderhoud actief wordt. De opgegeven waarde wordt afgerond naar beneden op hele minuten. Gedrag van eigenschap: - vereist voor aanmaakoperaties |
| active_till | timestamp | Tijd waarop het onderhoud niet meer actief is. De opgegeven waarde wordt afgerond naar beneden op hele minuten. Gedrag van eigenschap: - vereist voor aanmaakoperaties |
| description | string | Beschrijving van het onderhoud. |
| maintenance_type | integer | Type onderhoud. Mogelijke waarden: 0 - (standaard) met gegevensverzameling; 1 - zonder gegevensverzameling. |
| tags_evaltype | integer | Methode voor evaluatie van probleemtags. Mogelijke waarden: 0 - (standaard) En/Of; 2 - Of. |
Tijdsperiode
Het tijdsperiode-object wordt gebruikt om perioden te definiëren waarin het onderhoud van kracht moet zijn. Het heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| periode | integer | Duur van de onderhoudsperiode in seconden. De opgegeven waarde wordt afgerond naar beneden op hele minuten. Standaard: 3600. |
| tijdsperiode_type | integer | Type tijdsperiode. Mogelijke waarden: 0 - (standaard) eenmalig; 2 - dagelijks; 3 - wekelijks; 4 - maandelijks. |
| start_datum | timestamp | Datum waarop de onderhoudsperiode van kracht moet worden. De opgegeven waarde wordt afgerond naar beneden op hele minuten. Standaard: huidige datum. Gedrag van eigenschap: - ondersteund als tijdsperiode_type is ingesteld op "eenmalig" |
| start_tijd | integer | Tijdstip van de dag waarop het onderhoud begint in seconden. De opgegeven waarde wordt afgerond naar beneden op hele minuten. Standaard: 0. Gedrag van eigenschap: - ondersteund als tijdsperiode_type is ingesteld op "dagelijks", "wekelijks" of "maandelijks" |
| elke | integer | Voor dagelijkse en wekelijkse periodes bepaalt elke de dag- of weekintervallen waarop het onderhoud van kracht moet worden.Standaardwaarde als tijdsperiode_type is ingesteld op "dagelijks" of "wekelijks": 1.Voor maandelijkse periodes, wanneer dag is ingesteld, bepaalt de eigenschap elke de dag van de maand waarop het onderhoud van kracht moet worden.Standaardwaarde als tijdsperiode_type is ingesteld op "maandelijks" en dag is ingesteld: 1.Voor maandelijkse periodes, wanneer dagofweek is ingesteld, bepaalt de eigenschap elke de week van de maand waarop het onderhoud van kracht moet worden.Mogelijke waarden als tijdsperiode_type is ingesteld op "maandelijks" en dagofweek is ingesteld:1 - (standaard) eerste week; 2 - tweede week; 3 - derde week; 4 - vierde week; 5 - laatste week. Gedrag van eigenschap: - ondersteund als tijdsperiode_type is ingesteld op "dagelijks", "wekelijks" of "maandelijks" |
| dagofweek | integer | Dagen van de week waarop het onderhoud van kracht moet worden. Dagen worden opgeslagen in binaire vorm, waarbij elke bit de overeenkomstige dag vertegenwoordigt. Bijvoorbeeld, 4 staat voor 100 in binair en betekent dat het onderhoud op woensdag wordt ingeschakeld. Gedrag van eigenschap: - vereist als tijdsperiode_type is ingesteld op "wekelijks", of als tijdsperiode_type is ingesteld op "maandelijks" en dag niet is ingesteld- ondersteund als tijdsperiode_type is ingesteld op "maandelijks" |
| dag | integer | Dag van de maand waarop het onderhoud van kracht moet worden. Gedrag van eigenschap: - vereist als tijdsperiode_type is ingesteld op "maandelijks" en dagofweek niet is ingesteld- ondersteund als tijdsperiode_type is ingesteld op "maandelijks" |
| maand | integer | Maanden waarin het onderhoud van kracht moet zijn. Maanden worden opgeslagen in binaire vorm, waarbij elke bit de overeenkomstige maand vertegenwoordigt. Bijvoorbeeld, 5 staat voor 101 in binair en betekent dat het onderhoud wordt ingeschakeld in januari en maart. Gedrag van eigenschap: - vereist als tijdsperiode_type is ingesteld op "maandelijks" |
Probleemtag
Het probleemtagobject wordt gebruikt om te bepalen welke problemen onderdrukt moeten worden wanneer het onderhoud van kracht wordt. Tags kunnen alleen worden gespecificeerd als de maintenance_type van het Onderhoudsobject is ingesteld op "met gegevensverzameling". Het heeft de volgende eigenschappen.
| Eigenschap | Type | Omschrijving |
|---|---|---|
| tag | string | Naam van de probleemtag. Gedrag van eigenschap: - vereist |
| operator | integer | Vergelijkingsoperator. Mogelijke waarden: 0 - Gelijk aan; 2 - (standaard) Bevat. |
| value | string | Waarde van de probleemtag. |