レスポンスと例外 - Java SDK

APIResponse、BulkAPIResponse、FileAPIResponseは、Zoho CRM APIのレスポンスのラッパーオブジェクトです。すべてのAPI呼び出しメソッドは、これら3つのオブジェクトのいずれかを返します。

メソッド検索エンティティーはAPIResponseオブジェクトを返し、メソッド検索エンティティーのリストはBulkAPIResponseオブジェクトを返します。
record.downloadPhoto、record.downloadAttachmentなどのデータまたはメモから写真または添付ファイルをダウンロードするために、ファイルダウンロードAPIに対してFileAPIResponseが返されます。
getData()メソッドを使用して、エンティティーデータのみをレスポンスラッパーオブジェクトから取得できます。APIResponse.getData()は、単一のZoho CRMエンティティーオブジェクトを返し、BulkAPIResponse.getData()は、Zoho CRMエンティティーオブジェクトのリストを返します。
FileAPIResponseには、ダウンロードされたファイルの名前を返すFileAPIResponse.getFileName()と、ファイルの内容をInputStreamとして返すFileAPIResponse.getFileAsStream()の2つの定義済みメソッドがあります。

これらのレスポンスラッパーオブジェクトには、データ以外に次のプロパティーがあります。

ResponseHeaders - 現在の日付/ウィンドウの残りのAPIカウントと、現在のウィンドウがリセットされてから経過した時間。
ResponseInfo - 実際のデータに加えて、APIによって提供される場合は、その他の情報。
List<EntityResponse> - 一括APIの個々のエンティティーのステータス。たとえば、データの追加では、いくつかのデータのためにAPIが部分的に失敗することがあります。この配列は、個々のデータの作成ステータスを示してください。

SDKでは、アプリを起動するたびに、次のコード行を呼び出す必要があります。

ZCRMRestClient.initialize();

このメソッドは、アプリケーションを起動するためにjavaアプリケーションのメインクラスから呼び出す必要があります。例外なく呼び出す必要があります。

問題のあるAPIレスポンス、SDKの異常などの予期しない動作はすべてSDKによって処理され、単一の例外であるZCRMExceptionとしてのみスローされます。したがって、この例外を検出するには、クライアントアプリコードだけで十分です。