PurgePropertyHistory
Description
Lorsqu'une propriété journalisée est mise à jour, les données sont écrites dans un flux de valeurs associé à l'objet. Vous pouvez utiliser le service PurgePropertyHistory pour purger les données historiques d'une propriété journalisée dans une plage temporelle spécifiée.
L'historique des propriétés de l'objet sur lequel le service est appelé sera purgé, mais pas celui des autres objets. Si vous souhaitez purger les données historiques de plusieurs objets, vous devez appeler le service sur chacun d'eux.
Par défaut, cette purge s'exécute de manière asynchrone.
Entrée
Nom de paramètre
Description
Type de base
propertyName
Nom de la propriété dont les données historiques doivent être purgées.
STRING
startDate
Date de début à partir de laquelle les données historiques doivent être purgées (la date spécifiée est incluse).
DATETIME
endDate
Date de fin jusqu'à laquelle les données historiques doivent être purgées (la date spécifiée est incluse).
DATETIME
immediate
Si la valeur est false, la purge s'exécute de manière asynchrone. La valeur par défaut est false. Si vous la définissez sur true, la purge s'exécute de manière synchrone.
BOOLEAN
Sortie
Aucun.
Exemple
Dans l'exemple suivant, l'objet dispose d'une propriété journalisée nommée propertyA-Logged qui a été mise à jour plusieurs fois et collectait des données historiques.
Les paramètres d'entrée peuvent être transmis en ligne comme indiqué ci-dessous :
// Purging historical data between the given start and end dates
Things["TestThing"].PurgePropertyHistory({
propertyName: 'propertyA-Logged' /* STRING */,
startDate: '2024-05-12T16:58:28.000Z' /* DATETIME */,
endDate: 'Date.now()' /* DATETIME */,
immediate: true /* BOOLEAN {"defaultValue":false} */
});
Vous pouvez également construire une table d'informations.
// Params for purging historical data from the past year
var purgeHistoryParams = {
propertyName: 'propertyA-Logged' /* STRING */,
startDate: new Date(new Date().setFullYear(new Date().getFullYear() - 1)),
endDate: Date.now(),
immediate: true /* BOOLEAN */
};
Things["TestThing"].PurgePropertyHistory(purgeHistoryParams);
Est-ce que cela a été utile ?