Objet de maintenance

Les objets suivants sont directement liés à l’API maintenance.

Maintenance

L'objet de maintenance possède les propriétés suivantes.

Propriété Type Description
maintenanceid ID ID de la maintenance.

Comportement de la propriété :
- lecture seule
- obligatoire pour les opérations de mise à jour
name string Nom de la maintenance.

Comportement de la propriété :
- obligatoire pour les opérations de création
active_since timestamp Heure à laquelle la maintenance devient active (inclus).

La valeur fournie sera arrondie à la minute inférieure.

Comportement de la propriété :
- obligatoire pour les opérations de création
active_till timestamp Heure à laquelle la maintenance cesse d'être active (exclus).

La valeur fournie sera arrondie à la minute inférieure.

Comportement de la propriété :
- obligatoire pour les opérations de création
description string Description de la maintenance.
maintenance_type integer Type de 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 des balises de problème.

Valeurs possibles :
0 - (par défaut) Et/Ou ;
2 - Ou.

Période de temps

L'objet de période de temps est utilisé pour définir les périodes pendant lesquelles la maintenance doit entrer en vigueur. Il possède les propriétés suivantes.

Propriété Type Description
period integer Durée de la période de maintenance en secondes.

La valeur fournie sera arrondie à la minute inférieure.

Par défaut : 3600.
timeperiod_type integer Type de période de temps.

Valeurs possibles :
0 - (par défaut) une seule fois ;
2 - quotidien ;
3 - hebdomadaire ;
4 - mensuel.
start_date timestamp Date à laquelle la période de maintenance doit entrer en vigueur.
La valeur fournie sera arrondie à la minute inférieure.

Par défaut : date actuelle.

Comportement de la propriété :
- pris en charge si timeperiod_type est défini sur "one time only"
start_time integer Heure de la journée à laquelle la maintenance commence, en secondes.
La valeur fournie sera arrondie à la minute inférieure.

Par défaut : 0.

Comportement de la propriété :
- pris en charge si timeperiod_type est défini sur "daily", "weekly" ou "monthly"
every integer Pour les périodes quotidiennes et hebdomadaires, every définit les intervalles de jours ou de semaines auxquels la maintenance doit entrer en vigueur.
Valeur par défaut si timeperiod_type est défini sur "daily" ou "weekly" : 1.

Pour les périodes mensuelles lorsque day est défini, la propriété every définit le jour du mois auquel la maintenance doit entrer en vigueur.
Valeur par défaut si timeperiod_type est défini sur "monthly" et que day est défini : 1.

Pour les périodes mensuelles lorsque dayofweek est défini, la propriété every définit la semaine du mois à laquelle la maintenance doit entrer en vigueur.
Valeurs possibles si timeperiod_type est défini sur "monthly" et que dayofweek est défini :
1 - (par défaut) première semaine ;
2 - deuxième semaine ;
3 - troisième semaine ;
4 - quatrième semaine ;
5 - dernière semaine.

Comportement de la propriété :
- pris en charge si timeperiod_type est défini sur "daily", "weekly" ou "monthly"
dayofweek integer Jours de la semaine auxquels la maintenance doit entrer en vigueur.

Valeurs bitmap possibles :
1 - lundi ;
2 - mardi ;
4 - mercredi ;
8 - jeudi ;
16 - vendredi ;
32 - samedi ;
64 - dimanche.

Il s'agit d'un champ de masque de bits ; toute somme des valeurs bitmap possibles est acceptée (par exemple, 21 pour lundi, mercredi et vendredi).

Comportement de la propriété :
- obligatoire si timeperiod_type est défini sur "weekly" ou si timeperiod_type est défini sur "monthly" et que day n'est pas défini
day integer Jour du mois auquel la maintenance doit entrer en vigueur.

Comportement de la propriété :
- obligatoire si timeperiod_type est défini sur "monthly" et que dayofweek n'est pas défini
month integer Mois auxquels la maintenance doit entrer en vigueur.

Valeurs bitmap possibles :
1 - janvier ;
2 - février ;
4 - mars ;
8 - avril ;
16 - mai ;
32 - juin ;
64 - juillet ;
128 - août ;
256 - septembre ;
512 - octobre ;
1024 - novembre ;
2048 - décembre.

Il s'agit d'un champ de masque de bits ; toute somme des valeurs bitmap possibles est acceptée (par exemple, 585 pour janvier, avril, juillet et octobre).

Comportement de la propriété :
- obligatoire si timeperiod_type est défini sur "monthly"

Tag de problème

L'objet de tag de problème est utilisé pour définir quels problèmes doivent être supprimés lorsque la maintenance entre en vigueur. Les tags ne peuvent être spécifiés que si maintenance_type de l'objet de maintenance est défini sur « with data collection ». Il possède les propriétés suivantes.

Propriété Type Description
tag string Nom du tag de problème.

Comportement de la propriété :
- obligatoire
operator integer Opérateur de condition.

Valeurs possibles :
0 - Égal à ;
2 - (par défaut) Contient.
value string Valeur du tag de problème.