エラー・メッセージ
REST API for Sites Managementでエラーが発生した場合、レスポンス・ステータス・コードは4XXまたは5XXです。 レスポンスの本文には、エラー詳細オブジェクトとしてエラー・メッセージが表示されます。 次の表では、オブジェクトの属性について説明します:
| 属性 | 説明 |
|---|---|
type |
この属性には、問題タイプを識別する絶対URIが含まれます。 このURIが参照解除された場合、HTMLページなど、問題の人間が読めるサマリーを提供する必要があります。 これは必須フィールドであり、常に表示されます。 |
title |
問題の短く、判読可能なサマリー。 特定のエラーをチェックする方法として、この目的でo:errorCode(存在する場合)を使用することはお薦めしません。 次に例を示します:
これは必須フィールドであり、常に表示されます。 |
status |
エラーに対応するHTTPステータス・コードである数値属性。 |
detail |
この問題の発生に固有の説明。 人間が判読可能な複数行の可能性があり、その問題を詳細に説明します。 |
instance |
エラーに関する詳細を提供するリンクへのURI。 |
o:errorCode |
アプリケーション・エラー・コード。HTTPエラー・コードとは異なります。 このコードは、titleやdetailなどのフィールドを比較するのではなく、特定のエラーをチェックするために使用します。 |
o:errorPath |
エラーが発生した場所を示すXPathまたはJSONパス。 |
o:errorDetails |
この属性には、他のエラー詳細オブジェクトの配列が含まれます。 これらは通常、性質上補助的なものであるか、最上位エラーの根本原因を示します。 |