コンテンツにスキップ

$p.apiUsersUpdate

2020年1月21日2026年10月11日

概要¶

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

構文¶

JavaScript¶

$p.apiUsersUpdate({
    id: <ユーザID>,
    data: {
        <更新データ>
    },
    done: <任意の処理>,
    fail: <任意の処理>,
    always: <任意の処理>
});

※ Password、ApiKeyは変更できません。

パラメータ¶

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

使用例¶

$p.apiUsersUpdate({
    id: 123,
    data: {
        LoginId: 'HAYATO',
        Name: '中野 隼人',
        ClassHash: {
            ClassA: 'test-class-column'
        },
        NumHash: {
            NumA: 100
        },
        DateHash: {
            DateA: '2026-08-19'
        },
        DescriptionHash: {
            DescriptionA: '補足説明'
        },
        CheckHash: {
            CheckA: true
        }
    },
    done: function(data){
        console.log(data);
    },
    fail: function(data){
        console.log(data);
    }
});

戻り値¶

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

対応バージョン¶

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

関連情報¶