期間変更¶
指定されたデータの期間を変更します。期間化特性のマスタの場合、当APIを利用可能です。
リクエストボディ¶
リクエストボディ情報の説明です。
プロパティ名 論理名 型 設定 デフォルト値 説明 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)、新開始日(newStartDate)、新終了日(newEndDate)を指定してください。MasterBuilderの項目設定のプライマリーキー(genericMasterSettings / items / item @ primary)が「true」の項目が主キーです。新開始日(newStartDate)、新終了日(newEndDate)はyyyy/mm/dd形式で指定してください。主キーが一致するデータの期間を変更します。リクエストボディのjsonの設定例{ "data":{ "companyCd":"comp_sample_01", "id":"XXX", "renewCnt":"1", "newStartDate":"2000/01/01", "newEndDate":"2023/12/31" } }コラム
対象データで指定する更新カウンタ(renewCnt)は、排他チェックで使用します。指定した更新カウンタ(renewCnt)と、期間変更対象のデータの更新カウンタ(renewCnt)が不一致の場合、バリデートエラーになります。
レスポンスデータ¶
レスポンスデータはJSON情報を返却します。処理結果が正常の場合、リクエストしたデータに一致するデータが期間変更されます。レスポンスデータ例{ "statusCode":"200", "error":"false", "message":"対象期間のデータを変更しました。<br />[新期間開始日:2000/01/01, 新期間終了日:2023/12/31]", "errorMessage":"XXX" }解説
プロパティ名 論理名 型 説明 statusCode 処理ステータス string 200:正常終了401:エラー終了(認可によりアクセスが拒否)405:エラー終了(対象機能のAPI利用が不可)500:エラー終了(401、405以外のエラーが発生)error 処理結果 boolean true:エラー終了false:正常終了message メッセージ string 処理結果が正常終了の場合、「対象期間のデータを変更しました。<br />[新期間開始日:%新開始日%, 新期間終了日:%新終了日%] 」が設定されます。 errorMessage エラーメッセージ string 処理結果がエラー終了の場合、設定されます。