PurgePropertyHistory

Composer での ThingWorx モデルの定義 > モデル化 > コードスニペット > PurgePropertyHistory

説明

ログプロパティが更新されると、そのデータは Thing に関連付けられている値ストリームに書き込まれます。PurgePropertyHistory サービスを使用することにより、時間範囲を指定して 1 つのログプロパティから履歴データをパージできるようになります。

このサービスが呼び出された Thing のプロパティ履歴はパージされますが、その他の Thing のプロパティ履歴はパージされません。複数の Thing の履歴データをパージする場合、Thing ごとにサービスを呼び出す必要があります。

デフォルトでは、このパージは非同期で実行されます。

入力

パラメータ名	説明	ベースタイプ
propertyName	履歴データをパージするプロパティの名前。	STRING
startDate	履歴データをパージする期間の開始日 (指定した日付を含む)。	DATETIME
endDate	履歴データをパージする期間の終了日 (指定した日付を含む)。	DATETIME
immediate	false の場合、パージは非同期で実行されます。デフォルト値は false です。true に設定した場合、パージは同期的に実行されます。	BOOLEAN

出力

なし。

例

次の例では、Thing に propertyA-Logged という名前のログプロパティがあり、これは複数回更新されて履歴データが収集されています。

以下に示すように、入力パラメータをインラインで渡すことができます。

// 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} */
});

または、インフォテーブルを作成できます。

// 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);

これは役に立ちましたか?