getRelatedRecords 方法
目的
您可以使用 getRelatedRecords 方法来获取相关记录。
例如,您可以获取与市场活动相关的应聘者或获取与客户相关的任务。
请求 URL
XML 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Notes/getRelatedRecords?authtoken=Auth Token&scope=recruitapi&id=Record ID&parentModule=Module Name&version=2
JSON 格式:
https://recruit.zoho.com.cn/recruit/private/json/Notes/getRelatedRecords?authtoken=Auth Token&scope=recruitapi&id=Record ID&parentModule=Module Name&version=2
请求参数
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | 加密的字母数字字符串,用来对 Zoho 凭证进行身份验证。 |
scope* | 字符串 | 将值指定为 recruitapi |
parentModule* | 字符串 | 您想要从中获取相关记录的模块 示例:如果您想要获取与市场活动相关的应聘者,那么“市场活动”是您的父模块。 |
id* | 整数 | 您想要获取的相关记录的记录 id |
newFormat | 整数 | newFormat=1:从 Recruit 帐户插入数据时排除具有“空”值的字段。 newFormat=2:从 Recruit 帐户插入数据时包括具有“空”值的字段。 |
fromIndex | 整数 | 默认值 - 1 |
toIndex | 整数 | 默认值 - 20 最大值 - 200 |
version* | 整数 | 使用 version=2: 这将基于最新 API 实施来获取响应。 |
* - 必备参数
备注:getRelatedRecords 方法不支持自定义查找字段。
支持的相关列表
getRelatedRecords 方法目前支持备注和附件模块。
示例
查看附加到记录的文件
URL 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=recruitapi&parentModule=Candidates&id=508020000000957321
示例响应:
<response uri="/recruit/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[ 17.56 KB ]]>
</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[ 8.55 KB ]]>
</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[ 11.47 KB ]]>
</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[ 8.16 KB ]]>
</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://recruit.zoho.com.cn/recruit/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=recruitapi&id=RECORD_ID&parentModule=Module Name
示例响应:
<response uri="/recruit/private/xml/Notes/getRelatedRecords">
<result>
<Notes>
<row no="1">
<FL val="id">5080200000005483628</FL>
<FL val="Note Content">
<![CDATA[ New note under the record ]]>
</FL>
<FL val="SMOWNERID">508020000000065849</FL>
<FL val="Owner Name">
<![CDATA[ James ]]>
</FL>
<FL val="SMCREATORID">508020000000065849</FL>
<FL val="Created By">
<![CDATA[ James ]]>
</FL>
<FL val="Created Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FL val="MODIFIEDBY">508020000000065849</FL>
<FL val="Modified By">
<![CDATA[ James ]]>
</FL>
<FL val="Modified Time">
<![CDATA[ 2012-12-12 05:00:00 ]]>
</FL>
<FL val="ISVOICENOTES">
<![CDATA[ false ]]>
</FL>
</row>
</Notes>
</result>
</response>