Documentation
Table of Contents
> Objet maintenance
Les objets suivants sont directement liés à l'API maintenance.
Maintenance
L'objet maintenance a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| maintenanceid | string | (lecture seule) ID de la maintenance. |
| name (obligatoire) |
string | Nom de la maintenance. |
| active_since (obligatoire) |
timestamp | Heure à laquelle la maintenance devient active. |
| active_till (obligatoire) |
timestamp | Heure à laquelle la maintenance arrête d'être active. |
| description | string | Description de la maintenance. |
| maintenance_type | integer | Type de la maintenance. Valeurs possibles : 0 - (par défaut) avec collecte de données ; 1 - sans collecte de données. |
| tags_evaltype | integer | Méthode d'évaluation du tag de problème. Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
Période
L'objet période est utilisé pour définir les périodes pendant lesquelles la maintenance doit entrer en vigueur. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| timeperiodid | string | (lecture seule) ID de la période. |
| day | integer | Jour du mois où la maintenance doit entrer en vigueur. Requis seulement pour des périodes mensuelles. |
| dayofweek | integer | Jours de la semaine où la maintenance doit entrer en vigueur. Les jours sont stockés sous forme binaire, chaque bit représentant le jour correspondant. Par exemple, 4 est égal à 100 en binaire et signifie que la maintenance sera activée mercredi. Utilisé pour des périodes hebdomadaires et mensuelles. Requis seulement pour des périodes hebdomadaires. |
| every | integer | Pour les périodes quotidiennes et hebdomadaires, "every" définit les intervalles de jours ou de semaines où la maintenance doit entrer en vigueur. Pour les périodes mensuelles, "every" définit la semaine du mois où la maintenance doit entrer en vigueur. Valeurs possibles : 1 - première semaine ; 2 - deuxième semaine ; 3 - troisième semaine ; 4 - quatrième semaine ; 5 - dernière semaine. |
| month | integer | Mois où la maintenance doit entrer en vigueur. Les mois sont stockés sous forme binaire, chaque bit représentant le mois correspondant. Par exemple, 5 est égal à 101 en binaire et signifie que la maintenance sera activée en janvier et en mars. Requis seulement pour des périodes mensuelles. |
| period | integer | Durée de la période de maintenance en secondes. Par défaut : 3600. |
| start_date | timestamp | Date à laquelle la période de maintenance doit entrer en vigueur. Requis seulement pour une période. Par défaut : date actuelle. |
| start_time | integer | Heure de début de la maintenance en secondes. Requis pour des périodes quotidiennes, hebdomadaires et mensuelles. |
| timeperiod_type | integer | Type de période. Valeurs possibles : 0 - (par défaut) une fois seulement ; 2 - quotidien ; 3 - hebdomadaire ; 4 - mensuel. |
Tag de problème
L'objet tag de problème permet de définir les problèmes à supprimer lors de la prise en charge de la maintenance. Il a les propriétés suivantes.
| Propriété | Type | Description |
|---|---|---|
| tag (requis) |
string | Nom du tag de problème. |
| operator | integer | Condition de l'opérateur. Valeurs possibles : 0 - Egal ; 2 - (par défaut) Contient. |
| value | string | Valeur du tag de problème. |