コンテンツにスキップ
「プリザンター入門」発売中!

開発者向け機能:サーバスクリプト:items.BulkDelete

概要

指定したサイトのレコードを一括削除します。選択条件を指定して削除対象のレコードを絞り込むことができます。

構文

items.BulkDelete(siteId, data)

パラメータ

パラメータ 必須 概要
siteId long 対象テーブルのサイトIDを指定。
data string 一括削除するレコードの条件等をJSON形式で指定。JSONの仕様は レコード一括削除API の「設定値」を参照。

戻り値

一括削除したレコード数を返却します。削除できなかった場合は0を返却します。

使用例 1

以下の例では、サイトID 123 のテーブルにある Status(状況) が 900(完了) のレコードを削除します。

JavaScript
let data = {
    View: {
        ColumnFilterHash: {
            Status: "[900]"
        }
    }
};
items.BulkDelete(123, JSON.stringify(data));

使用例 2

以下の例では、サイトID 123 のテーブルにある レコードIDが 1000,1003,1400のレコードを削除します。

JavaScript
let data = {
    Selected: [1000,1003,1400]
};
items.BulkDelete(123, JSON.stringify(data));

使用例 3

以下の例では、サイトID 123 のテーブルにある全レコードを削除します。

JavaScript
let data = {
    All: true
};
items.BulkDelete(123, JSON.stringify(data));

注意事項

こちらはサーバスクリプトで使用するメソッドです。スクリプトでは使用できません。

関連情報

テーブルの管理:サーバスクリプト
オブジェクトごとの実行タイミング
itemsオブジェクト