APIエラーレスポンス

概要

各モジュール・オペレーション別に、APIリクエスト時に発生するエラーの一覧をまとめます。 各レスポンスには code、message、fieldの項目が含まれています。

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

エラー一覧

Login

API	Condition	HTTP Status	Code	Field	Message(ja)	Message(en)	Note
login	ログイン認証失敗	401	unauthorized	-	Invalid credentials	Invalid credentials	"errors"の他に"status": 1も返却される（ログイン成功時は"status": 0）
profile	未ログイン（AccessToken未指定）	401	-	-	-	-	{"errors": [ "[GW] Access Token is required"]}
token	GrantToken不正	401	unauthorized	-	Grant token is invalid, revoked or expired	Grant token is invalid, revoked or expired

Topics

API	Condition	HTTP Status	Code	Field	Message(ja)	Message(en)	Note
list / detail	記事グループID無し 記事ID無し	404	not_found	-	-	-
insert / update	記事グループID無し		bad_request	-	コンテンツ定義は存在しません。	Content Structure does not exist.
	タイトルなし	400	invalid	subject	タイトルは必須項目です。	Title is required
	拡張データ:テキスト 必須チェック（パラメータなし）	400	required	ext_col_xx	Required property missing	Required property missing
	拡張データ:テキスト 必須チェック（空文字）	400	required	ext_col_xx	String is too short	String is too short
	拡張データ:テキスト 入力制限（E-mail）	400	invalid	ext_col_xx	Textが不正です。 E-mail形式で入力してください。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（電話番号）	400	invalid	ext_col_xx	Textが不正です。 電話番号形式で入力してください。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（郵便番号）	400	invalid	ext_col_xx	Textが不正です。 郵便番号形式で入力してください。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（URL）	400	invalid	ext_col_xx	Textが不正です。 URL形式で入力してください。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（数値）	400	invalid	ext_col_xx	Textが不正です。 数値形式で入力してください。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（正規表現）	400	invalid	ext_col_xx	Textが不正です。	Invalid Text Please enter in a {1} format.
	拡張データ:テキスト 入力制限（文字数）	400	invalid	ext_col_xx	Textの文字数が不正です。	Invalid The Number of characters of Text

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

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

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

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