PurgeStreamEntries

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

PurgeStreamEntries

説明

このサービスが呼び出されたストリーム Thing のストリームエントリがパージされます。複数のストリームの履歴データをパージする場合、各ストリーム Thing に対してこのサービスを呼び出すことができます。

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

入力

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

出力

なし。

例

次の例では、TestStream に複数のエントリがあり、時間の経過とともに各エントリのデータが累積しています。次のスニペットを使用して、時間範囲を指定してそのデータをパージできます。

// Params for purging stream entry data from the past year
var purgeStreamEntriesParams = {
startDate: new Date(new Date().setFullYear(new Date().getFullYear() - 1)), /* DATETIME */,
endDate: Date.now(), /* DATETIME */,
immediate: true /* BOOLEAN {"defaultValue":false} */
};
Things["TestStream"].PurgeStreamEntries(purgeStreamEntriesParams);

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