getRelatedRecordsメソッド
目次
目的
getRelatedRecordsメソッドを使用すると、関連するデータを取得できます。
たとえば、キャンペーンに関連する見込み客を取得したり、取引先に関連するタスクを取得したりすることができます。
Request URL
XML形式：
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
JSON形式：
https://crm.zoho.com/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：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。 newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。 |
| fromIndex | 整数 | デフォルト値 - 1 |
| toIndex | 整数 | デフォルト値 - 20 最大範囲値 - 200 （最大範囲値 = toIndex - fromIndex） |
* - 必須パラメーター
注：
- getRelatedRecordsメソッドは、カスタム検索項目をサポートしていません。
サポート対象の関連リスト
getRelatedRecordsメソッドは、メール、競合、連携（Zoho Support、Zoho Projectsなど）を除くすべてのタブとその各関連リストをサポートします。
例
キャンペーン（id 121212121）に関連する見込み客を取得する
URL形式：
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
商談に関連するステージの履歴を取得する
URL形式：
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Deals
商談に関連する連絡先の役割を取得する
URL形式：
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Deals
データに添付されているファイルを表示する
URL形式：
https://crm.zoho.com/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/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>