getSearchRecordsByPDCメソッド

目的

このメソッドを使用すると、標準項目やカスタム検索項目に基づいて値を検索できます。

リクエストURL

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

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

リクエストパラメーター

パラメーターデータ型説明
authotoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列範囲としてcrmapiを指定してください。
selectColumns*文字列Allまたはタブ(項目1,項目2,項目3,項目n...)
例：leads(Last Name,Website,Email)
fromIndex整数デフォルト値 - 1
toIndex整数デフォルト値 - 20
最大範囲値 - 200
（最大範囲値 = toIndex - fromIndex）
searchColumn*文字列

標準の検索項目（下記の標準項目を参照）を指定してください。

注：カスタム検索項目に基づいて値を検索することもできます。

searchValue*文字列検索する値を指定してください。
newFormat整数newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。
newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。

* - 必須パラメーター

注：

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

デフォルトの標準項目

タブ項目
見込み客
  • email
取引先
  • accountid
  • accountname
連絡先
  • contactid
  • accountid
  • vendorid
  • email
商談
  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname
Campaigns
  • campaignid
  • campaignname
問い合わせ
  • caseid
  • productid
  • accountid
  • potentialid
ソリューション
  • solutionid
  • productid
商品
  • productid
  • vendorid
  • productname
発注書
  • purchaseorderid
  • contactid
  • vendorid
見積書
  • quoteid
  • potentialid
  • accountid
  • contactid
受注書
  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid
請求書
  • invoiceid
  • accountid
  • salesorderid
  • contactid
仕入先
  • vendorid
  • vendorname
タスク
  • taskid
予定
  • eventid
メモ
  • notesid

例

email項目で20件目から200件目までの見込み客を検索する

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi&fromIndex=20&toIndex=200&selectColumns=leads(Last Name,Website,Email)&searchColumn=email &searchValue=abc@testingdomain.com

email項目で見込み客を検索する

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=email
&searchValue=test@test.com

campaignid項目で見込み客を検索する

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=campaignid
&searchValue=2000000017011

vendorid項目で連絡先を検索する

https://crm.zoho.com/crm/private/xml/Contacts/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Contacts(Contact Owner,Lead Source,First Name,Last Name,Account Name)
&searchColumn=vendorid
&searchValue=2000000017022

vendorid項目で商品を検索する

https://crm.zoho.com/crm/private/xml/Products/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Products(Product Owner,Product Name,Product Code,Manufacturer,Product Category,Unit Price)
&searchColumn=vendorid
&searchValue=2000000017022

accountid項目で受注書を検索する

https://crm.zoho.com/crm/private/xml/SalesOrders/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=SalesOrders(SO Number,Subject,Due Date,Carrier,Status)
&searchColumn=accountid
&searchValue=2000000017003

カスタム検索項目を使用してデータを検索する

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&searchColumn=ProductLookup_ID
&searchValue=108149000062016

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

<Leads>
<row no="1">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">Scott</FL>
<FL val="SMCREATORID">1081490000078001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">1081490000078001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-10-27 15:18:11</FL>
<FL val="Modified Time">2014-11-26 12:53:13</FL>
<FL val="Last Activity Time">2014-11-26 12:53:13</FL>
<FL val="ProductLookup_ID">108149000062016</FL>
<FL val="ProductLookup">CPU</FL>
</row>
</Leads>

テストプログラム

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

  • 認証トークン作成形式
  • パラメーターとその値
  • メソッドの実際の使用

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