getRecordById 方法
目的
您可以使用此方法利用记录 ID 检索个别记录。
请求 URL
XML 格式:
https://crm.zoho.com.cn/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
JSON 格式:
https://crm.zoho.com.cn/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 = 1: (默认值)这将基于之前的 API 执行即在进行强化之前获取响应。 version = 2: 这将基于上一次 API 执行获取响应。 |
* - 必填参数
注意:
- 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。
示例
如需按照 ID 获取记录,使用下文给出的 URL:
https://crm.zoho.com.cn/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
如需按照 ID 列表获取记录,使用下文给出的 URL:
https://crm.zoho.com.cn/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
注意:
- 您可以使用 id 或 idlist 参数获取记录。 使用 "id" 参数检索唯一 ID 的记录。 使用 "idlist" 参数检索所需 ID 的记录。
如需在未指定 newFormat 参数的情况下获取线索
注意:
- 没有关于响应格式的指定时,默认值 "1" 分配给 newFormat 参数,即 newFormat = 1。
https://crm.zoho.com.cn/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.cn/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 程序包含以下内容:
- 验证令牌生成格式
- 参数及其数值
- 方法的实际使用
点击此处下载程序