getRecordByIdメソッド

目的

このメソッドを使用すると、データIDで個々のデータを取得できます。

リクエストURL

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

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

リクエストパラメーター

パラメーターデータ型説明
authtoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列値をcrmapiと指定してください。
id*またはidlist*文字列

id：データの一意のIDを指定してください。

idlist：一意のIDセットを指定します（セミコロンで区切ります）。このパラメーターを使用して最大100個のIDを指定できます。

newFormat整数（1または2）newFormat=1：CRMアカウントからデータを取得する際、「null」値を持つ項目を除外します。newFormat=2：CRMアカウントからデータを取得する際、「null」値を持つ項目を含めます。
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。

* - 必須パラメーター

注：

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

例

IDを使ってデータを取得するには、以下のURLを使用してください。

https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID

IDリストを使ってデータを取得するには、以下のURLを使用してください。

https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100

注：

  • idまたはidlistパラメーターを使用してデータを取得できます。一意のIDのデータを取得するには、idパラメーターを使用してください。任意のIDのデータを複数取得するには、idlistパラメーターを使用してください。

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

注：

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

https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=2000000022020&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>

idlistパラメーターを指定して見込み客を取得する

https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=108490000014005;108490000020024

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

<Leads>
<row no="1">
<FL val="LEADID">108490000015005</FL>
<FL val="SMOWNERID">10849000015001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">100</FL>
<FL val="SMCREATORID">10849000014001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">10849000015001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-04-30 17:41:05</FL>
<FL val="Modified Time">2014-10-08 14:41:21</FL>
<FL val="Last Activity Time">2014-10-08 14:42:16</FL>
</row>
<row no="2">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Acme 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>
</row>
</Leads>

テストプログラム

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

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

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