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

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

概要

「サーバスクリプト」から新しいグループを作成します。「groups」オブジェクトのメソッドです。

メソッド

groups.Create(group);

パラメータ

パラメータ 説明 必須
group 作成するグループ情報をJSON形式の文字列で指定します。

使用例

下記の例では新しいグループを作成します。

(function () {
    const group = {
        GroupName: "新しいグループ",
        Body: "dddddd",
        Disabled: false,
        Comments: "created-by-server-script",
        ClassHash: {
            ClassA: "test-class-column"
        }
    };

    const ok = groups.Create(JSON.stringify(group));
    context.Log("groups.Create returned:", ok);
})();

戻り値

説明
boolean グループの作成に成功した場合はtrue、失敗した場合はfalseを返します。

拡張項目に値を設定する

「拡張項目」に値を設定する場合は、ClassHashにカラム名と値を指定してください。

ClassHash: {
    ClassA: "test-class-column"
}

対応バージョン

対応バージョン 内容
1.5.8.0 以降 機能追加