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

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

概要

サーバスクリプトで、グループIDを指定して1件のグループ情報を取得します。

メソッド

groups.Get(groupId);

パラメータ

パラメータ 必須 説明
groupId long 取得対象のグループIDを指定します。

使用例

const group = groups.Get(5);
if (group) {
    context.Log(group.GroupName + ', ' + group.Body);
} else {
    context.Log('対象のグループが存在しません。');
}

戻り値

「groupオブジェクト」を返します。オブジェクトのレイアウトは「開発者向け機能:サーバスクリプト:group」を参照してください。指定したIDのグループが存在しない場合は null を返します。

{
    "TenantId": 1,
    "GroupId": 5,
    "GroupName": "新しいグループ",
    "Body": "dddddd",
    "Disabled": false,
    "ClassHash": {
        "ClassA": "test-class-column"
    },
    "ClassHash": {
        "ClassA": "test-class-column"
    },
    "NumHash": {
        "NumA": 100
    },
    "DateHash": {
        "DateA": "2026-08-19"
    },
    "DescriptionHash": {
        "DescriptionA": "補足説明"
    },
    "CheckHash": {
        "CheckA": true
    }
}

注意事項

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

対応バージョン

対応バージョン 内容
1.5.8.0 以降 拡張項目の値を取得する機能を追加