コンテンツにスキップ

groups.Update

2023年3月28日2026年10月11日

概要¶

サーバスクリプトで指定したグループIDのグループを更新します。

前提条件¶

本機能によるグループの更新にはサイトの管理者権限が必要です。サイトの管理者権限がないユーザで更新したい場合、サイトの管理権限をもったユーザのAPIキーの指定が必要です。

構文¶

groups.Update(groupId, data)

パラメータ¶

パラメータ	型	必須	説明
groupId	long	○	対象グループのグループIDを指定
data	string	○	更新内容をJSON形式で指定。指定内容は「JSONデータレイアウト：Group」を参照してください

戻り値¶

指定したグループが更新できた場合には true、更新できなかった場合には false を返却します。

使用例¶

下記の例では、グループ 100 のグループのメンバーをユーザID 5 のユーザ、組織ID 3 の組織で更新します。メンバーがユーザの場合は "User,ユーザID,管理者権限(true/false)"、組織の場合は "Dept,組織ID,管理者権限(true/false)" を指定してください。メンバーの更新は指定したもので全て洗い替えとなります。

JavaScript¶

const apiKey = 'xxxxx...';
const userId = 5;
const deptId = 3;
const groupId = 100;
let groupMembers = [
    `User,${userId},true`,
    `Dept,${deptId},false`
];
const data = {
    ApiKey: apiKey,
    GroupMembers: groupMembers,
    ClassHash: {
        ClassA: 'test-class-column'
    },
    NumHash: {
        NumA: 100
    },
    DateHash: {
        DateA: '2026-08-19'
    },
    DescriptionHash: {
        DescriptionA: '補足説明'
    },
    CheckHash: {
        CheckA: true
    }
};
groups.Update(groupId, JSON.stringify(data));

対応バージョン¶

対応バージョン	内容
1.5.8.0 以降	拡張項目を更新する機能を追加

関連情報¶