searchRecordsメソッド
目的
searchRecordsメソッドを使用すると、検索条件を満たすデータのリストを取得できます。
リクエストURL
XML形式:
https://crm.zoho.com/crm/private/xml/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))
JSON形式:
https://crm.zoho.com/crm/private/json/Leads/searchRecords?authtoken=Auth Token&scope=crmapi&criteria=(((Last Name:Steve)AND(Company:Zillum))OR(Lead Status:Contacted))
リクエストパラメーター
パラメーター | データ型 | 説明 |
authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
scope* | 文字列 | 値をcrmapiと指定してください。 |
criteria* | 文字列 | [リクエストURL]セクションに表示されている検索条件を指定してください。 |
selectColumns | 文字列 | タブ(オプション列)形式(Leads(Last Name,Website,Email)など)またはAllと指定してください。 |
fromIndex | 整数 | デフォルト値 - 1 |
toIndex | 整数 | デフォルト値 - 20 最大範囲値 - 200 (最大範囲値 = toIndex - fromIndex) |
lastModifiedTime | yyyy-MM-dd HH:mm:ss | デフォルト値:null 時間を指定すると、指定した時間以降に作成/変更されたデータが取得されます。 |
newFormat | 整数 | newFormat=1:値が「null」の項目を除外して、CRMアカウントにデータを挿入します。 newFormat=2:値が「null」の項目を含めて、CRMアカウントにデータを挿入します。 |
* - 必須パラメーター
注:
- このメソッドは、1分間に60回だけトリガーできます。
- 1日に実行できる呼び出し回数は最大10,000回です。ただし、プランのAPI数が10,000未満の場合は、このメソッド使用時に組織数が適用されます。
- equals条件とstartsWith条件を使用して、最大5つの条件(同じ列または異なる列を指定)を使用できます。このメソッドでは、他の演算子はサポートされません。
- API実装で行われた強化の詳細については、リリースノートページを参照してください。
レスポンス例
<response uri="/crm/private/xml/Leads/searchRecords">
</response>