Skip to content

カタログ項目を作成する

post

/catalogs/{catalog_name}/items/{item_id}

このエンドポイントを使用して、カタログにアイテムを作成する。

前提条件

このエンドポイントを使用するには、API キーcatalogs.create_itemの権限が必要です。

レート制限

パスパラメーター

パラメータ required データ型 説明
catalog_name 必須 文字列 カタログ名。
item_id 必須 文字列 カタログ項目のID。

リクエストパラメーター

パラメーター required データ型 説明
items required 配列 アイテム・オブジェクトを含む配列。アイテムオブジェクトは、id フィールドを除く、カタログのすべてのフィールドを含むべきである。1つのリクエストにつき、1つのアイテムオブジェクトのみが許可される。

例のリクエスト

応答

このエンドポイントには、201400404 という 3 つのステータスコード応答があります。

成功応答の例

ステータスコード 201 は、次の応答本文を返す可能性があります。

エラー応答例

ステータスコード 400 は、次の応答本文を返す可能性があります。遭遇する可能性のあるエラーの詳細については、「トラブルシューティング」を参照のこと。

トラブルシューティング

次のテーブルに、返される可能性のあるエラーと、関連するトラブルシューティングステップを示します。

エラー トラブルシューティング
arbitrary-error 任意のエラーが発生した。もう一度試すか、サポートに連絡する。
catalog-not-found カタログ名が有効であることを確認する。
filtered-set-field-too-long フィールド値は、項目の文字数制限を超えるフィルターセットで使用されている。
id-in-body リクエスト本文の項目 ID を削除します。
ids-too-large 各アイテムIDの文字数制限は250文字である。
invalid-ids アイテムID名に使用できる文字は、アルファベット、数字、ハイフン、アンダースコアである。
invalid-fields APIリクエストで送信するすべてのフィールドが、すでにカタログに存在していることを確認する。これは、エラーに記載されている ID フィールドとは関係ありません。
invalid-keys-in-value-object 項目オブジェクトのキーに . または $ を含めることはできません。
item-already-exists そのアイテムはすでにカタログに存在する。
item-array-invalid items はオブジェクト配列でなければなりません。
items-too-large 各項目の文字数制限は5,000文字である。
request-includes-too-many-items 1つのリクエストにつき1つのカタログ項目しか作成できない。
too-deep-nesting-in-value-object アイテム・オブジェクトは50レベル以上の入れ子を持つことはできない。
unable-to-coerce-value 項目タイプは変換できません。
「このページはどの程度役に立ちましたか?」
New Stuff!