getRelatedRecords 方法
目录
目的
您可以使用 getRelatedRecords 方法获取相关记录。
例如: 您可以获取宣传相关的线索或获取账户相关的任务。
请求 URL
XML 格式:
https://crm.zoho.com.cn/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
JSON 格式:
https://crm.zoho.com.cn/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
请求参数
参数 | 数据类型 | 说明 |
authtoken* | 字符串 | 验证您的 Zoho 凭据的加密字母数字字符串。 |
scope* | 字符串 | 将数值指定为crmapi |
parentModule* | 字符串 | 您想要获取相关记录的模块 示例: 如果您想获取宣传相关的线索,那么宣传就是您的父模块。 |
id* | 整数值 | 您想要获取相关记录的记录 id |
newFormat | 整数值 | newFormat=1: 插入来自您的 CRM 账户的数据时排除有 "null" 的字段。 newFormat=2:插入来自您的 CRM 账户的数据时将有 "null" 的字段包括在内。 |
fromIndex | 整数值 | 默认值 - 1 |
toIndex | 整数值 | 默认值 - 20 最大值 - 200 |
* - 必填参数
注意:
- getRelatedRecords 方法不支持自定义查找字段。
支持的相关列表
getRelatedRecords 方法支持所有模块及其各自的相关列表,但邮件、竞争对手和集成(Zoho Support、Zoho Projects等)除外。
示例
获取宣传相关的线索(使用 id 121212121)
URL 格式:
https://crm.zoho.com.cn/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
获取潜在客户相关的阶段历史
URL 格式:
https://crm.zoho.com.cn/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Potentials
获取潜在客户相关的联系人角色
URL 格式:
https://crm.zoho.com.cn/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Potentials
查看记录所附的文档
URL 格式:
https://crm.zoho.com.cn/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321
样本响应
<response uri="/crm/private/xml/Attachments/getRelatedRecords">
<result>
<Attachments>
<row no="1">
<FL val="id">5080200000005483628</FL>
<FL val="File Name">
<![CDATA[ wallpaper.jpeg ]]>
</FL>
<FL val="Size">
<![CDATA[ 175662 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:36 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="2">
<FL val="id">5080200000000906253</FL>
<FL val="File Name">
<![CDATA[ image.jpeg ]]>
</FL>
<FL val="Size">
<![CDATA[ 8550 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="3">
<FL val="id">5080200000009873561</FL>
<FL val="File Name">
<![CDATA[ sample-image.jpg ]]>
</FL>
<FL val="Size">
<![CDATA[ 114775 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
<row no="4">
<FL val="id">5080200000001928374</FL>
<FL val="File Name">
<![CDATA[ test-img.jpg ]]>
</FL>
<FL val="Size">
<![CDATA[ 8161 bytes ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-07-03 14:58:35 ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Attached By">
<![CDATA[ charles stone]]>
</FL>
</row>
</Attachments>
</result>
</response>
获取记录下的备注
URL 格式:
https://crm.zoho.com.cn/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name
样本响应
<responseuri="/crm/private/xml/Notes/getRelatedRecords">
<result>
<Notes>
<rowno="1">
<FLval="id">5080200000005483628</FL>
<FLval="Note Content">
<![CDATA[ New note under the record ]]>
</FL>
<FLval="SMOWNERID">508020000000065849</FL>
<FLval="Owner Name">
<![CDATA[ James ]]>
</FL>
<FLval="SMCREATORID">508020000000065849</FL>
<FLval="Created By">
<![CDATA[ James ]]>
</FL>
<FLval="Created Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FLval="MODIFIEDBY">508020000000065849</FL>
<FLval="Modified By">
<![CDATA[ James ]]>
</FL>
<FLval="Modified Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FLval="ISVOICENOTES">
<![CDATA[ false ]]>
</FL>
</row>
</Notes>
</result>
</response>