更新¶

指定されたデータを更新します。

HTTPリクエスト
リクエストボディ
レスポンスデータ

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/master/renew

リクエストボディ ¶

リクエストボディ情報の説明です。

プロパティ名論理名型設定デフォルト値説明

masterId マスタID string マスタIDを保持するマスタの場合、必須なし MasterBuilderのマスタIDを指定します。

extensionId マスタ拡張ID string 任意なし MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。

gadgetClass ガジェットクラス string ガジェットクラスを保持するマスタの場合、必須なし GadgetBuilderのガジェットクラス「master」を指定します。

gadgetVariation ガジェットバリエーション string ガジェットバリエーションを保持するマスタの場合、必須なし GadgetBuilderのガジェットバリエーションを指定します。

json JSON object 任意なしマスタの更新値をJSON形式で指定します。

json/data 更新データ object 必須なし

「”項目名”:”更新値”,”項目名”:”更新値”…」の形式で指定します。

項目名には、MasterBuilderの項目設定の項目名（genericMasterSettings / items / item @ name）が指定可能です。

各マスタの主キー（国際化特性のマスタのロケールIDは除く）、更新したい項目、更新カウンタ（renewCnt）を指定してください。

MasterBuilderの項目設定のプライマリーキー（genericMasterSettings / items / item @ primary）が「true」の項目が主キーです。

主キーが一致するデータを更新します。

json/data/details 更新データ（明細） array<object> 明細があるマスタの場合、必須なし

ブロックタイプが「DETAIL」の項目を指定します。

明細が存在しないマスタに指定した場合、無視されます。

「{“項目名”:”登録値”,”項目名”:”登録値”…},」の形式で指定します。

更新時、明細行は削除して再度データを登録します。

そのため、更新時も各マスタの必須項目は必ず指定する必要があります。

リクエストボディのjsonの設定例
{
    "data":{
        "companyCd":"comp_sample_01",
        "id":"XXX",
        "name_l_ja":"WWW",
        "name_l_en":"WWW",
        "name_l_zh_CN":"WWW",
        "renewCnt":"1",
        "details":[
            {"filed1":"XXX","field2":"XXX"},
            {"filed1":"YYY","field2":"YYY"}
        ]
    }
}
コラム

次の項目は自動的に設定するため、更新データとしての指定は不要です。

更新日時（renewTs）

更新ユーザ（renewUserCd）

コラム

次の項目は更新できません。

各マスタの主キー

登録日時（entry_ts）

登録ユーザ（entry_user_cd）

期間化特性のマスタの開始日（startDate）

期間化特性のマスタの終了日（endDate）

期間化特性のマスタの削除フラグ（deleteFlag）

コラム

国際化対応の項目の項目名は「項目名_l_%ロケールID%」と指定してください。

使用するロケール分の項目名を指定する必要があります。

コラム

更新時にはバリデートが実行され、バリデートエラーが発生した場合500エラーが発生します。

実行されるバリデートはMasterBuilderの項目設定のバリデート設定（genericMasterSettings / items / item / validates / validate）を参照してください。

コラム

更新データで指定する更新カウンタ（renewCnt）は、排他チェックで使用します。

指定した更新カウンタ（renewCnt）と、更新対象のデータの更新カウンタ（renewCnt）が不一致の場合、バリデートエラーになります。

更新カウンタ（renewCnt）は、更新前の値を指定してください。

更新時に自動でカウントアップします。

レスポンスデータ ¶

レスポンスデータはJSON情報を返却します。

処理結果が正常の場合、リクエストしたデータに一致するデータが更新されます。

レスポンスデータ例
{
    "statusCode":"200",
    "error":"false",
    "message":"更新しました。",
    "errorMessage":"XXX"
}
解説

プロパティ名論理名型説明

statusCode 処理ステータス string

200：正常終了

401：エラー終了（認可によりアクセスが拒否）

405：エラー終了（対象機能のAPI利用が不可）

500：エラー終了（401、405以外のエラーが発生）

error 処理結果 boolean

true：エラー終了

false：正常終了

message メッセージ string 処理結果が正常終了の場合、「更新しました。」が設定されます。

errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。

目次

更新¶

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶

目次

プロパティ名	論理名	型	設定	デフォルト値	説明
masterId	マスタID	string	マスタIDを保持するマスタの場合、必須	なし	MasterBuilderのマスタIDを指定します。
extensionId	マスタ拡張ID	string	任意	なし	MasterBuilderをカスタマイズして、マスタ拡張IDを設定している場合、指定します。
gadgetClass	ガジェットクラス	string	ガジェットクラスを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットクラス「master」を指定します。
gadgetVariation	ガジェットバリエーション	string	ガジェットバリエーションを保持するマスタの場合、必須	なし	GadgetBuilderのガジェットバリエーションを指定します。
json	JSON	object	任意	なし	マスタの更新値をJSON形式で指定します。
json/data	更新データ	object	必須	なし	「”項目名”:”更新値”,”項目名”:”更新値”…」の形式で指定します。項目名には、MasterBuilderの項目設定の項目名（genericMasterSettings / items / item @ name）が指定可能です。各マスタの主キー（国際化特性のマスタのロケールIDは除く）、更新したい項目、更新カウンタ（renewCnt）を指定してください。 MasterBuilderの項目設定のプライマリーキー（genericMasterSettings / items / item @ primary）が「true」の項目が主キーです。主キーが一致するデータを更新します。
json/data/details	更新データ（明細）	array<object>	明細があるマスタの場合、必須	なし	ブロックタイプが「DETAIL」の項目を指定します。明細が存在しないマスタに指定した場合、無視されます。「{“項目名”:”登録値”,”項目名”:”登録値”…},」の形式で指定します。更新時、明細行は削除して再度データを登録します。そのため、更新時も各マスタの必須項目は必ず指定する必要があります。

プロパティ名	論理名	型	説明
statusCode	処理ステータス	string	200：正常終了 401：エラー終了（認可によりアクセスが拒否） 405：エラー終了（対象機能のAPI利用が不可） 500：エラー終了（401、405以外のエラーが発生）
error	処理結果	boolean	true：エラー終了 false：正常終了
message	メッセージ	string	処理結果が正常終了の場合、「更新しました。」が設定されます。
errorMessage	エラーメッセージ	string	処理結果がエラー終了の場合、設定されます。

目次

更新¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶