エラーメッセージの形式

API要求の処理中にエラーが発生すると、エラーメッセージが返されます。次の表に、エラーメッセージのJSONペイロードに含まれる属性の一覧を示します。

属性

データタイプ

説明

errorCode

文字列

発生したエラーの種類を一意に識別する文字列。特定のエラー状態をプログラムで処理するために便利です。

message

文字列

発生したエラーの短い説明。

details

文字列

エラーの詳細な説明。

recommendedActions

配列<文字列>

推奨されるユーザーの操作や、特定のエラー状態の解決を示す文字列のリスト。

nestedErrors

配列<ErrorMessage>

マルチパートエラー(たとえば、形式検証エラー)の場合、このフィールドには、エラーの個々のコンポーネント(たとえば、エラーとなっている個々のフィールド)の詳細が含まれる場合があります。

errorSource

文字列

マルチパートエラー(たとえば、形式検証エラー)の場合、このフィールドには、エラーとなっているサブコンポーネント(たとえば、個々のフィールド名)の識別子が含まれます。

data

オブジェクト

エラーに関連付けられている内部/追加のデータ。外部クライアントは通常このフィールドを無視します。