1.2.6 ステータスコード
API実行によるレスポンスメッセージのステータスコードを次の表に示します。
ステータスコード |
名前 |
説明 |
|---|---|---|
200 |
OK |
リクエストが適切に処理された場合。 |
201 |
Created |
リソース作成処理が成功した場合，200の代わりにこちらを返却する。 |
204 |
No Content |
リクエストは成功したが，返すべきレスポンスが存在しない場合，200の代わりにこちらを返却する。 |
303 |
See Other |
要求を別のURIを用いて処理させる場合，200の代わりにこちらを返却する。 |
400 |
Bad Request |
リクエストが不正であった場合に返却する。クエリパラメータの指定範囲不正を含む。 |
401 |
Unauthorized |
リソースにアクセスするために認証が必要であることを通知する。認証方法はWWW-Authenticateヘッダーで通知する。既にAuthorizationヘッダーを含んだリクエストを行っている場合，認証がそれらのユーザー情報またはhsso tokenに対して拒否されたことを示す。認証が拒否される理由として，指定したユーザー情報(ユーザーIDまたはパスワード)やhsso tokenが不正以外にも，JP1/OAに対する操作権限がない場合が考えられます。 |
403 |
Forbidden |
該当するオペレーションを実施する権限がない場合。 |
404 |
Not found |
リソース及びオペレーションが存在しない場合。 |
405 |
Method Not Allowed |
リソースに存在しないメソッドを呼び出した場合。存在するメソッド一覧を必ず返す。 |
406 |
Not Acceptable |
サポート外のレスポンス形式が指定された場合。 |
409 |
Conflict |
サーバに既に存在しているデータが競合しているため，リクエストを完了できない。 |
412 |
Precondition Failed |
要求が前提条件を満たさないため受け付けられない場合。 |
|
414 |
Request-URI Too Long |
リクエストラインが長過ぎる場合。 |
415 |
Unsupported Media Type |
サポート外のリクエスト形式が指定された場合。 |
500 |
Server-Side Error |
サーバでの処理エラーに対して返却する。 |
503 |
Service Unavailable |
リポジトリーサーバでエラーが発生した場合。 |
4XX,5XX 系のステータスコードの場合，レスポンスボディーが「text/html」形式または「text/plain」形式で返却されることがあります。この場合レスポンスヘッダーに「Content-Type: text/html」または「Content-Type: text/plain」が指定されます。
4XX,500 系のステータスコードだけでは原因を特定しにくいものに関して，レスポンスにエラーのより詳細な内容を提供しています。
上記のステータスコードの使用有無はAPIごとに異なるため，各APIの説明を参照してください。