getRelatedRecords methode
Inhoudsopgave
Doel
U kunt de getRelatedRecords methode gebruiken voor het ophalen van gerelateerde records.
Bijvoorbeeld: u kunt leads ophalen die gerelateerd zijn aan een campagne of taken ophalen die gerelateerd zijn aan een account.
URL van het verzoek
XML-indeling:
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
JSON-indeling:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Parameters van het verzoek
| Parameter | Gegevenstype | Beschrijving |
| authtoken* | String | Versleutelde alfanumerieke tekenreeks ter verificatie van uw Zoho inloggegevens. |
| scope* | String | Voer als waarde crmapi in |
| parentModule* | String | Module waarvoor u de gerelateerde records wilt ophalen Voorbeeld: als u leads wilt ophalen gerelateerd aan een campagne, dan is Campaigns de parent module. |
| id* | Integer | De id van de record waarvoor u gerelateerde records wilt ophalen |
| newFormat | Integer | newFormat=1: Om velden met 'null'-waarden uit te sluiten wanneer u gegevens uit uw CRM-account invoegt. newFormat=2:Om velden met 'null'-waarden op te nemen wanneer u gegevens uit uw CRM-account invoegt. |
| fromIndex | Integer | Standaardwaarde - 1 |
| toIndex | Integer | Standaardwaarde - 20 Maximale bereikwaarde - 200 [Maximale bereikwaarde = toIndex - fromIndex] |
* - Verplichte parameter
Opmerking:
- De getRelatedRecords methode biedt geen support voor aangepaste opzoekvelden.
Ondersteunde gerelateerde lijsten
De getRelatedRecords methode ondersteunt alle modules en hun respectieve gerelateerde lijsten behalve e-mails, concurrenten en integraties (Zoho Support, Zoho Projects, etc.)
Voorbeelden
Ophalen van leads met betrekking tot een campagne ( met id 121212121 )
URL-indeling:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
Ophalen van geschiedenis van fases gerelateerd aan een deal
URL-indeling:
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Deals
Ophalen van contactpersoonrollen gerelateerd aan een deal
URL-indeling:
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Deals
Bekijken van een aan een record toegevoegd bestand
URL-indeling:
https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321
Voorbeeld response
<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>
Ophalen van notities onder een record
URL-indeling:
https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name
Voorbeeld response
<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>