getRecordsメソッド

目次

目的

getRecordsメソッドを使用すると、APIリクエストで指定された全ユーザーのデータを取得できます。

リクエストURL

XML形式：
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi

JSON形式：
https://crm.zoho.com/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi

リクエストパラメーター

パラメーターデータ型説明
authtoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列値をcrmapiと指定してください。
selectColumns文字列タブ(オプション列)形式（leads(Last Name,Website,Email)など）またはAllと指定してください。
fromIndex整数デフォルト値 - 1
toIndex整数デフォルト値 - 20
最大範囲値 - 200
（最大範囲値 = toIndex - fromIndex）
sortColumnString文字列sortColumnStringパラメーターを使用する場合、デフォルトではデータは昇順で並べ替えられます。
sortOrderString文字列デフォルト値：asc
降順で並べ替える場合は、sortOrderString=descを渡してください。
lastModifiedTime日時デフォルト値：null
時間を指定すると、指定した時間以降に変更されたデータが取得されます。
newFormat整数newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。
newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。

* - 必須パラメーター

注：

  • API実装で行われた強化の詳細については、リリースノートページを参照してください。

エラーの取得

CRM APIは、CRMとアプリケーション間でデータを同期しながら、プログラムの問題をかんたんにトラブルシューティングできるようにする、一意のエラーコードを提供します。各種エラーコードとその定義の詳細については、エラーコードを参照してください。

その他の注意事項

  • Zoho CRMからデータを取得する際には、ユーザーの項目単位のセキュリティが適用されます。そのため、すべてのユーザーデータを取得するには、最も上位の役職（CEOなど）と権限（管理者など）を持つユーザーIDを使用してください。
  • fromIndexとtoIndexは、オプションのパラメーターです。デフォルトでは、fromlndexは1、toIndexは20に設定されます。
  • sortColumnStringとsortOrderStringもオプションのパラメーターです。
  • lastModifiedTimeパラメーターの値は、yyyy-MM-dd HH:mm:ss形式にする必要があります。

例

取引先名（降順）で並べ替えた全取引先の20-200件目をJSON形式で取得する

URL形式：

https://crm.zoho.com/crm/private/json/Accounts/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=crmapi&fromIndex=20&toIndex=200&sortColumnString=Account Name&sortOrderString=desc

2008/05/27 0:00:00以降に変更/作成された全取引先をXML形式で取得する

URL形式：

https://crm.zoho.com/crm/private/xml/Accounts/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=crmapi&lastModifiedTime=2008-05-27 00:00:00

version = 1を使用して見込み客を取得する

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company,Campaign Source)&version=1
以下のようなレスポンスが返されます。

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">scott@zillum.com</FL>
<FL val="CAMPAIGNID">2000000072001</FL>
<FL val="Campaign Source">Webinar</FL>
</row>
</Leads>

version = 2を使用して見込み客を取得する

以下のようなレスポンスが返されます。

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">scott@zillum.com</FL>
</row>
</Leads>

newFormatパラメーターを指定せずに見込み客を取得する

注：

  • レスポンス形式に関する指定がない場合、デフォルト値「1」がnewFormatパラメーターに割り当てられます。つまり、newFormat = 1となります。

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)

以下のようなレスポンスが返されます。

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>

newFormat=2を使用して取得する

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)
以下のようなレスポンスが返されます。

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>

fromIndex=1、toIndex=25を使用して呼び出す

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&fromIndex=1&toIndex=25

注：

  • 1~25件目のデータが返されます。

lastModifiedTimeを使用して呼び出す

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23

注：

  • 時間を指定すると、指定した時間以降に作成/変更されたデータが取得されます。

newFormat=1を使用して見込み客の全項目を選択する

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1&selectColumns=All

注：

  • 値を持つすべての項目が返されます。

newFormat=2を使用して見込み客の全項目を選択する

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
&newFormat=2&selectColumns=All

注：

  • 値がnullの項目を含め、すべての項目が返されます。

lastModifiedTime、fromIndex、toIndexを使用して呼び出す

https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi&newFormat=1
&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)
&lastModifiedTime=2010-04-21 11:09:23
&fromIndex=1
&toIndex=25

lastModifiedTime、fromIndex、toIndexを使用して呼び出す（［アカウント］タブの場合）

https://crm.zoho.com/crm/private/xml/Accounts/getRecords?authtoken=Auth Token&scope=crmapi&newFormat=1
&selectColumns=Accounts(Account Owner,Account Name,Phone,Industry)
&lastModifiedTime=2010-04-21 11:09:23
&fromIndex=1
&toIndex=25

テストプログラム

添付のプログラムを使用すると、Java環境でgetRecordsメソッドの動作を実行、テストできます。
このJavaプログラムには、以下が含まれています。

  • チケット作成形式
  • パラメーターとその値
  • メソッドの実際の使用

プログラムをダウンロードするには、こちらをクリックしてください。