コンテンツにスキップ

$p.apiGroupsUpdate

2022年7月19日2026年10月11日

概要¶

AjaxのPOSTリクエストにより、グループを更新します。

構文¶

JavaScript¶

$p.apiGroupsUpdate({
    id: <対象のグループID>,
    data: {
        <更新するグループ情報>
    },
    done: <任意の処理>,
    fail: <任意の処理>,
    always: <任意の処理>
});

パラメータ¶

パラメータ名	型	必須	概要
id	long	○	対象のグループID
data	object		更新するグループ情報をJSON形式で指定 ※欄外補足参照
done	function	○	API通信成功時に実行する処理
fail	function		API通信失敗時に実行する処理
always	function		API通信完了時に実行する処理
※更新するグループ情報は、APIグループ更新時と同等のパラメータを設定します。リンク先のマニュアルを参照にパラメータを設定してください。

使用例¶

$p.apiGroupsUpdate({
    id: 123,
    data: {
        GroupName: '更新後グループ名',
        Body: '更新後グループ内容',
        ClassHash: {
            ClassA: 'test-class-column'
        },
        NumHash: {
            NumA: 100
        },
        DateHash: {
            DateA: '2026-08-19'
        },
        DescriptionHash: {
            DescriptionA: '補足説明'
        },
        CheckHash: {
            CheckA: true
        },
        GroupMembers: [
            'User,1,True',
            'Dept,1,False'
        ],
        GroupChildren: [
            'Group,1',
        ]
    },
    done: function (data) {
        console.log(data);
        console.log('グループ情報の更新に成功しました。');
    },
    fail: function () {
        console.log('グループ情報の更新に失敗しました。');
    },
    always: function () {
        console.log('グループ情報の更新が完了しました。');
    }
});

戻り値¶

API通信成功時に「done」に渡される値は、API「グループ更新」のレスポンスと同じ形式です。

サンプルコード¶

1. プロジェクトグループの作成・メンバー反映・廃止を申請レコードで行う

このサンプルは「$p.apiGroupsCreate」のサンプルコードにあります。

対応バージョン¶

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

関連情報¶