PurgeStreamEntries

Composer 中的 ThingWorx 模型定義 > 建模 > 程式碼片段 > PurgeStreamEntries

PurgeStreamEntries

描述

將清除呼叫服務之串流物件的串流項目。如果您要清除多個串流的歷史資料，可以針對每個串流物件呼叫此服務。

依預設，清除會以非同步方式執行。

輸入

參數名稱	描述	基礎類型
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);

這是否有幫助?