CRMヘルプ

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)
lastModifiedTimeyyyy-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">

<result>
<Leads>
<row no="1">
<FL val="LEADID">508020000000556003</FL>
<FL val="SMOWNERID">508020000000050003</FL>
<FL val="Lead Owner">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Company">
<![CDATA[ Zillum ]]>
</FL>
<FL val="Last Name">
<![CDATA[ Steve ]]>
</FL>
<FL val="No of Employees">
<![CDATA[ 0 ]]>
</FL>
<FL val="Annual Revenue">
<![CDATA[ 0 ]]>
</FL>
<FL val="SMCREATORID">508020000000050003</FL>
<FL val="Created By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="MODIFIEDBY">508020000000050003</FL>
<FL val="Modified By">
<![CDATA[ John Doe ]]>
</FL>
<FL val="Created Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
<FL val="Email Opt Out">
<![CDATA[ false ]]>
</FL>
<FL val="Currency">
<![CDATA[ INR ]]>
</FL>
<FL val="Exchange Rate">
<![CDATA[ 1.000000000 ]]>
</FL>
<FL val="Last Activity Time">
<![CDATA[ 2013-06-26 10:37:48 ]]>
</FL>
</row>
</Leads>
</result>
</response>

この記事をシェアする : FacebookTwitter

必要な情報は見つかりましたか?

メールお問い合わせ窓口: support@zohocrm.com