APIエラーレスポンス

概要

コンテンツ定義に設定できるバリデーションのエラーの一覧をまとめます。 各レスポンスには code、message、fieldの項目が含まれています。

• code: エラー種別コードを意味する文字列（例：リクエストパラメータが無効な場合はinvalidが入ります）
• message: Kuroco標準のエラーメッセージ
• field: エラーが発生したリクエストパラメータ、総合的なエラーの場合は出力されません

注記

本リファレンスには、コンテンツ定義に設定されたバリデーションのエラーを記載しています。リクエストに問題がある場合は、別のエラーが発生します。

バリデーションエラー一覧

共通

Condition	HTTP Status	Code	Message(ja)	Message(en)
必須チェック	400	required	[項目名]は必須項目です。	[item name] is required

タイトル

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（E-mail）	400	invalid	ext_x	タイトルが不正です。 E-mail形式で入力してください。	Invalid Title. Please enter in a {1} format.
入力制限（電話番号）	400	invalid	ext_x	タイトルが不正です。 電話番号形式で入力してください。	Invalid Title. Please enter in a {1} format.
入力制限（郵便番号）	400	invalid	ext_x	タイトルが不正です。 郵便番号形式で入力してください。	Invalid Title. Please enter in a {1} format.
入力制限（URL）	400	invalid	ext_x	タイトルが不正です。 URL形式で入力してください。	Invalid Title. Please enter in a {1} format.
入力制限（数値）	400	invalid	ext_x	タイトルが不正です。 数値形式で入力してください。	Invalid Title. Please enter in a {1} format.
入力制限（正規表現）	400	invalid	ext_x	タイトルが不正です。	Invalid Title. Please enter in a {1} format.
入力制限（最小文字数）	400	invalid	ext_x	タイトルの文字数が不正です。	Title should be {1} characters or more.
入力制限（最大文字数）	400	invalid	ext_x	タイトルの文字数が不正です。	Please input Title within {5} characters.

テキスト

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（E-mail）	400	invalid	ext_x	[項目名]が不正です。 E-mail形式で入力してください。	Invalid [item name] Please enter in a {1} format.
入力制限（電話番号）	400	invalid	ext_x	[項目名]が不正です。 電話番号形式で入力してください。	Invalid [item name] Please enter in a {1} format.
入力制限（郵便番号）	400	invalid	ext_x	[項目名]が不正です。 郵便番号形式で入力してください。	Invalid [item name]. Please enter in a {1} format.
入力制限（URL）	400	invalid	ext_x	[項目名]が不正です。 URL形式で入力してください。	Invalid [item name]. Please enter in a {1} format.
入力制限（数値）	400	invalid	ext_x	[項目名]が不正です。 数値形式で入力してください。	Invalid [item name]. Please enter in a {1} format.
入力制限（正規表現）	400	invalid	ext_x	[項目名]が不正です。	Invalid [item name]. Please enter in a {1} format.
入力制限（最小文字数）	400	invalid	ext_x	[項目名]の文字数が不正です。	[item name] should be {1}(min characters) characters or more.
入力制限（最大文字数）	400	invalid	ext_x	[項目名]の文字数が不正です。	Please input [item name] within {5}(max characters) characters.

画像(KurocoFilesにアップロード)

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（拡張子）	400	invalid	ext_x	[項目名][ファイル名]が不正です。	Invalid [item name][File name]
入力制限（ファイル容量制限）	400	invalid	ext_x	[項目名]容量オーバーのためファイルはアップロードできませんでした。	[item name] Could not upload: the file size is too big

ファイル(KurocoFilesにアップロード)

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（拡張子）	400	invalid	ext_x	[項目名][ファイル名]が不正です。	Invalid [item name][File name]
入力制限（ファイル容量制限）	400	invalid	ext_x	[項目名]容量オーバーのためファイルはアップロードできませんでした。	[item name] Could not upload: the file size is too big

ファイル(GSCにアップロード)

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（拡張子）	400	invalid	ext_x	[項目名][ファイル名]が不正です。	Invalid [item name][File name]

ファイル(S3にアップロード)

Condition	HTTP Status	Code	Field	Message(ja)	Message(en)
入力制限（拡張子）	400	invalid	ext_x	[項目名][ファイル名]が不正です。	Invalid [item name][File name]

エラーレンスポンスサンプル

コンテンツ追加APIでsubjectが空文字、もしくは未指定だった場合のエラーのレスポンスサンプルは下記になります。

{
  "errors": [
    {
      "code": "invalid",
      "message": "タイトルは必須項目です。",
      "field": "subject"
    }
  ],
  "x-rcms-request-id": "280496b2-8b45-4a9a-8a21-678feb77e2ff"
}

• 特定の項目に対するエラーの場合は field に対象項目が含まれています。