削除¶

指定されたデータを削除します。

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

HTTPリクエスト ¶

POST /kaiden/v2/api/generic/master/delete

リクエストボディ ¶

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

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

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 必須なし

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

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

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

主キーが一致するデータを削除します。

明細があるマスタの場合、主キーが一致するデータに紐づく明細データも削除対象になります。

リクエストボディのjsonの設定例
{
    "data":{
        "companyCd":"comp_sample_01",
        "id":"XXX",
        "renewCnt":"1"
    }
}
コラム

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

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

コラム

削除対象データで指定する更新カウンタ（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	必須	なし	「”項目名”:”値”,”項目名”:”値”…」の形式で指定します。各マスタの主キー（国際化特性のマスタのロケールIDは除く）、更新カウンタ（renewCnt）を指定してください。 MasterBuilderの項目設定のプライマリーキー（genericMasterSettings / items / item @ primary）が「true」の項目が主キーです。主キーが一致するデータを削除します。明細があるマスタの場合、主キーが一致するデータに紐づく明細データも削除対象になります。

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

目次

削除¶

HTTPリクエスト¶

リクエストボディ¶

レスポンスデータ¶

目次

HTTPリクエスト ¶

リクエストボディ ¶

レスポンスデータ ¶