カテゴリマスタを編集する

Description

入力情報をもとにカテゴリマスタ情報の登録、変更、削除を行います。
変更を行う場合は、未設定の項目をnullで更新するため、編集を行わない項目も設定する必要があります。
また変更、削除を行う場合は、本API実行前に「カテゴリマスタを検索する」にて対象のカテゴリマスタ情報を検索し、「バージョン情報」を取得する必要があります。

Method

POST

Request Header

共通リクエストヘッダーを参照してください。

Argument

なし

URI

/API/v2/api/category

Parameters in request body

共通仕様はこちらを参照してください。
下記の例には一部項目を記載しています。全項目の詳細は表を参照してください。

Example

▼ Exampleを展開

{
    "entry_id":"C10000000000001",
    "category_master_edition_list": [
        {
            "category_id":"000000000000001",
            "apply_start_date":"20170601",
            "apply_end_date":"20221231",
            "display_flag":"1",
            "display_priority": 1,
            "free_item":
            {
                "Item01":"TEST01",
                "Item02":"TEST02"
            },
            "free_item1":"TEST00001",
            "free_item2":"TEST00002",
            "free_item3":"TEST00003",
            "free_item4":"TEST00004",
            "free_item5":"TEST00005",
            "free_item6":"TEST00006",
            "free_item7":"TEST00007",
            "free_item8":"TEST00008",
            "free_item9":"TEST00009",
            "free_item10":"TEST00010",
            "version_info": 1,
            "category_master_formultilingual_information_list" : [
                {
                    "language_locale":"ja",
                    "category_name":"カテゴリ０１",
                    "category_description":"説明"
                },
                {
                    "language_locale":"en",
                    "category_name":"Category 01",
                    "category_description":"Description"
                }
            ]
        }
    ]
}

Parameters

▼ Request Bodyを展開

Name			Type	Required	Length （Long/Decimalの場合はValue）	Description
entry_id			String	Yes	1 ～ 15	登録者ＩＤ 登録の処理を行ったユーザーのID
category_master_edition_list			list		Multiple	カテゴリマスタ編集リスト
	category_id		String		15	カテゴリＩＤ カテゴリを一意に識別するＩＤ 変更、削除時必須
	apply_start_date		String		8	適用開始年月日 サービスの適用を開始する年月日（当日を含む） 登録、変更時必須 yyyyMMdd形式
	apply_end_date		String		8	適用終了年月日 サービスの適用を終了する年月日（当日を含む） yyyyMMdd形式
	display_flag		String		1	表示フラグ カテゴリの表示フラグ
	upper_hierarchy_category_id		String		15	階層上位カテゴリＩＤ 上位のカテゴリを表す
	display_priority		Long		1 ～ 999	表示優先度 表示優先度を表す 登録、変更時必須
	free_item		String		1 ～ 30000	フリー項目
	free_item1		String		1 ～ 1000	フリー項目１
	free_item2		String		1 ～ 1000	フリー項目２
	free_item3		String		1 ～ 1000	フリー項目３
	free_item4		String		1 ～ 1000	フリー項目４
	free_item5		String		1 ～ 1000	フリー項目５
	free_item6		String		1 ～ 1000	フリー項目６
	free_item7		String		1 ～ 1000	フリー項目７
	free_item8		String		1 ～ 1000	フリー項目８
	free_item9		String		1 ～ 1000	フリー項目９
	free_item10		String		1 ～ 1000	フリー項目１０
	version_info		Long		1 ～ 999999999	バージョン情報 変更、削除時必須 共通仕様はこちらを参照
	deletion_targeted_flag		String		1	削除対象フラグ 削除時必須
	category_master_formultilingual_information_list		list		Multiple	カテゴリマスタ多言語用情報リスト
		language_locale	String	Yes	2	言語ロケール
		category_name	String		1 ～ 50	カテゴリ名 登録時必須
		category_description	String		1 ～ 3000	カテゴリ説明

Return Codes

Code	Description
200	レスポンスが正常の場合は処理成功。レスポンスが異常の場合は入力パラメータエラー。
401	認証エラー。API認証時のエラー。
403	アクセス不可
404	対象なし。対象の情報が見つからない場合。
409	排他エラー。対象の情報が別のプロセスによって処理されている場合。
500	業務不整合。整合性チェックエラー、またはその他のサーバー側のエラー。

Response Header

なし

Response Parameter

共通仕様はこちらを参照してください。

• レスポンス（正常）

Example

▼ Exampleを展開

{
    "result_information":{
        "result":"OK"
    },
    "category_id_information_list":[
        {
            "category_id":"000000000000001"
        }
    ]
}

Parameters

▼ Responseを展開

Name		Type	Required	Length （Long/Decimalの場合はValue）	Description
result_information		list		Single	結果情報
	result	String		2	結果 OKまたはNGを返却
	detailed_result	String		1 ～ 256	結果詳細 NGの場合、エラー内容を返却
category_id_information_list		list		Multiple	カテゴリＩＤ情報リスト
	category_id	String	Yes	15	カテゴリＩＤ カテゴリを一意に識別するＩＤ

• レスポンス（異常）
  共通エラー情報を参照してください。

Top