ページを選択

API: エラー処理

API: エラー処理

API は標準の HTTP ステータス コードによってエラーを通知します。つまり、レスポンスが成功すると 2xx ステータス コードが返され、エラーは 4xx または 5xx で報告されます。

TestRail API を使用するアプリケーションやライブラリは、5xx エラーに対処する必要があり、5xx の場合は後でリクエストを再試行することが期待されています。4xx エラーはクライアント側のエラーであり、通常、リクエストが不正、または不完全であること、たとえば存在しないテスト ケースを読み取ろうとしている、または無効な要求形式を使用していることを示します。下記のステータス コードそれぞれについて、レスポンスのボディにはリクエストの成功または失敗に関する追加の情報が含まれます。

レスポンス コード 説明
200 成功。
400 リクエストされたエンティティが存在しないか、POST リクエストのボディの書式が適切ではありません。
401 認証が失敗しました。認証情報が無効である可能性があります。
403 アクセスが拒否されました。パーミッションが適切ではない可能性があります。
404 API エンドポイントが存在しません。
409 アカウントは日次メンテナンス中です (TestRail Cloud のみ)。
429 API レート制限に到達しました (TestRail Cloud のみ)
500 サーバー エラー。