レスポンスとエラー
レスポンスの形式とステータスコード
レスポンスはプレーンな JSON で、呼び出しが成功したかどうかは HTTP ステータスコードでわかります。
レスポンス
成功した呼び出しは、オブジェクトそのもの、またはリストとそのサイズを返します。
{ "count": 2, "records": [ { "id": 41 }, { "id": 42 } ] }
エラーはメッセージを返し、詳細があればそれも返します。
{ "error": "The form data is not valid", "details": [ ... ] }
ステータスコード
ステータスコードで、何が問題だったかがわかります。
| コード | 意味 |
|---|---|
200 | 呼び出しが成功しました |
400 | リクエストの形式が正しくありません。たとえば、リフレッシュトークンのないトークン更新や、ファイルのないアップロードです |
401 | トークンがない、間違っている、または期限切れです。ログインするか更新してください |
403 | ユーザーのロールではその呼び出しが許可されていません（承認で allowSelf: true が設定されているか管理者でない限り、自分のジョブの承認も含みます）。または、アカウントで先に行うべきことがあります（下記を参照） |
404 | オブジェクトが存在しません |
409 | リクエストが不完全です（データのない起動）。または、オブジェクトがその操作を許可する状態にありません |
422 | 起動時の検証 がフォームの値を拒否しました。理由は details に列挙されています |
429 | ログインとトークンのエンドポイントへのリクエストが多すぎるか、ログインの失敗が多すぎます（ 認証 を参照） |
500 | サーバーで失敗しました。理由はサーバーログにあります |
ジョブの場合、 409 は操作に対してジョブの状態が正しくないことを意味します。実行中でない（またはすでに中止が要求された）ジョブの中止、 まだ実行中のジョブの再起動、承認待ちでなくなったジョブの承認や拒否です。
コード付きの 403
403 の応答の中には code が付いているものがあります。ほかの呼び出しが動くようになる前に、ユーザーがブラウザーで行うべきことを示します。
{ "error": "...", "code": "password_change_required" }
| コード | 行うこと |
|---|---|
password_change_required | ユーザーが公開されている既定のパスワードでサインインしました。まずプロフィールで変更してください |
disclaimer_required | 免責事項が有効で、ユーザーがまだその現在のバージョンに同意していません。ブラウザーで同意してください |
長期間有効な API トークン（ 認証 を参照）が免責事項によって止められることはありません。