エラー・メッセージ
次の表は、ドキュメントのREST APIにリクエストを送信したときに返されるエラー・メッセージの3つのフィールドについて説明しています。
| エラー・メッセージのフィールド | エラー・メッセージのフィールドの説明 |
|---|---|
errorCode |
数値: 0は、エラーがないことを意味します。 エラー値は、-1から-99までの数値です。 |
errorKey |
エラーのタイプを示すシステム解析可能なキーです。 |
errorMessage |
エラーを説明するユーザーが読取り可能なメッセージです。 このメッセージの言語は、Accept-Languageヘッダーを設定して変更できます。 |
エラー・コード
一部のステータス・コードには、問題を診断しやすいようにフォルト・レスポンスの本文が伴います。
次の表では、アクションのフォルト・レスポンス本文のerrorCodeフィールドによって返される一般的なエラー・コードについて説明します。 レスポンスのerrorMessageフィールドには、エラーの詳細が表示されます。
| エラー・コード | 説明 |
|---|---|
| 0 |
アクションが正常に処理されました。 |
| -1 |
一般的なエラー。 このコードは、具体的なステータス・コードがない場合に返されます。 |
| -16 |
指定された名前またはIDのフォルダまたはファイルが、指定された場所に存在しません。 これは、HTTP 404レスポンス・コードとして返されるのが普通です。 |
| -17 |
同じ名前のフォルダまたはファイルが、対象の場所にすでに存在します。 |
| -20 |
リクエストされた操作を実行する十分な権限がユーザーにありません。 これは、HTTP 403レスポンス・コードとして返されるのが普通です。 |
| -26 |
リンクは無効または期限切れです。 これは、HTTP 400レスポンス・コードとして返されるのが普通です。 |
次の例では、エラー・コードと、レスポンスのメッセージ部分を示しています。
{
"errorCode": "-16",
"errorMessage": "Security validation failed. 'FABCDEFGHIJKLMNOPQRSTUVWT0000000000100000001' does not exist. The error was caused by an internally generated issue. The error has been logged."
}