REST API応答

REST API応答が成功すると、要求されたオブジェクト、オブジェクトの配列、またはHTTP成功コードが返されます。失敗した応答はHTTPエラーコードを返しますが、エラーオブジェクトを返すこともあります。

成功した応答

要求タイプ	応答
GET	情報要求では、要求されたオブジェクトまたは該当するオブジェクトの配列が返されます。アクション要求では、HTTP 200成功コードが返されます。REST API成功オブジェクトも返すことができます。
POST	作成または更新したオブジェクトを返します。 HTTP 201成功コードを返すこともあります。
DELETE	HTTP 200成功コード。 REST API成功オブジェクトも返すことができます。

例えば、GET要求を使用してスケジュールを表示した場合、成功した応答とは、要求したスケジュールオブジェクトです。また、POST要求を使用してスケジュールの実行時間を更新した場合、成功した応答とは、更新を含む更新したスケジュールオブジェクトです。DELETE要求を使用して不要なスケジュールを削除した場合、成功した応答とは、200成功コードです。

失敗した応答

応答が失敗した場合、REST APIは標準のHTTPエラーコードを返しますが、エラーオブジェクトを返すこともあります。次の表に、返される可能性があるHTTPエラーコードの一部を示します。

HTTPエラーコード	説明
400	不正な要求です。無効な文字や不適切な文字列の長さなど、フィールドまたは形式の問題である可能性があります。
401	認証の問題。例えば、無効な認証情報または無効なセッションIDです。
403	一般的なエラー。例えば、ユーザーがリソースに必要な権限を持っていない場合などがあります。
404	リソースが見つかりません。
500	予期しないエラーです。予期しない状況が発生したときに表示される一般的なエラーメッセージ。
502	ネットワークの問題。
503	サービスが使用不可能になりました。サーバーが要求を処理できません。