エラーレスポンス

APIリクエストで4xxエラーが発生した場合は、RFC 7807 - Problem Details for HTTP APIsに準拠した形式でエラーレスポンスを返します。

エラーレスポンスフォーマット

リクエストが成功すると、2xxの範囲のHTTPステータスが返されます。
失敗したリクエストは、4xx, 5xxの範囲のHTTPステータスを返します。
通常、4xxエラーが発生した場合はエラーに関する情報を含むJSONドキュメントがレスポンスに含まれます。

次の例は、 401 Unauthorized エラーが発生した際のものです。

HTTP/1.1 401 Unauthorized

{
    "type": "https://{HOST_NAME}/v1/docs/errors/unauthorized",
    "status": 401,
    "title": "Unauthorized"
}

キー名	説明
type	エラーを識別するためのコードです。
status	HTTPステータスが含まれます。
title	発生したエラーの簡単な説明が含まれます。
error	発生したエラーの単一の補足情報が含まれます。補足情報が存在しない場合、または複数の補足情報が含まれる場合は使用されません。
errors	複数の `error` 要素が含まれます。補足情報が単一の場合、または補足情報が存在しない場合は使用されません。

HTTPステータスとエラーコードの説明です。 1xx Informational, 2xx Success 及び 3xx Redirection に関しては含まれません。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/invalid-payload	400	リクエストのバリデーションに失敗した場合に返されます。
https://{HOST_NAME}/v1/docs/errors/invalid-type	400	リクエストされたタイプが不正な場合に返されます。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/unauthorized	401	認証が必要なエンドポイントで認証が失敗した場合に返されます。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/full-id	403	リクエストしたノードのIDの登録数が制限に到達した際に返されます。制限は制限事項から確認できます。
https://{HOST_NAME}/v1/docs/errors/full-links	403	リクエストしたノードの紐付け数が制限に到達した際に返されます。制限は制限事項から確認できます。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/not-exists-type	404	リクエストされたタイプが存在しない場合に返されます。
https://{HOST_NAME}/v1/docs/errors/not-exists-id	404	リクエストされたIDが存在しない場合に返されます。
https://{HOST_NAME}/v1/docs/errors/not-exists-schema	404	リクエストされたスキーマが存在しない場合に返されます。
https://{HOST_NAME}/v1/docs/errors/not-exists-node	404	リクエストされたノードが存在しない場合に返されます。
https://{HOST_NAME}/v1/docs/errors/not-exists-link	404	リクエストされた紐付け情報が存在しない場合に返されます。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/link-already-exists	409	リクエストされた紐付け情報がすでに存在している場合に返されます。
https://{HOST_NAME}/v1/docs/errors/id-already-exists	409	リクエストされたIDがすでに存在している場合に返されます。
https://{HOST_NAME}/v1/docs/errors/node-already-exists	409	リクエストされたノードがすでに存在している場合に返されます。

エラーコード	ステータス	説明
https://{HOST_NAME}/v1/docs/errors/too-many-requests	429	過度なリクエストなどでデータベースがロックされている場合に返されます。

サーバ側で問題が発生した際に返されます。
5xxエラーが発生した際は、リトライを行ってください。