Méthode getRelatedRecords
Table des matières
Objectif
Vous pouvez utiliser la méthode getRelatedRecords pour récupérer des enregistrements liés.
Par exemple : vous pouvez récupérer des prospects liés à une campagne ou récupérer des tâches liées à un compte.
URL de la requête
Format XML :
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Format JSON :
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Paramètres de la requête
| Paramètre | Type de données | Description |
| authtoken* | Chaîne | Chaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho. |
| scope* | Chaîne | Spécifiez la valeur comme crmapi. |
| parentModule* | Chaîne | Module pour lequel vous souhaitez récupérer les enregistrements liés. Exemple : si vous souhaitez récupérer des prospects liés à une campagne, alors Campaigns (Campagnes) est votre module parent. |
| id* | Nombre entier | ID de l'enregistrement pour lequel vous souhaitez récupérer des enregistrements liés. |
| newFormat | Nombre entier | newFormat=1 : pour exclure les champs avec des valeurs « null » lors de l'insertion de données depuis votre compte CRM. newFormat=2 : pour inclure les champs avec des valeurs « null » lors de l'insertion de données depuis votre compte CRM. |
| fromIndex | Nombre entier | Valeur par défaut - 1 |
| toIndex | Nombre entier | Valeur par défaut - 20 Valeur de plage maximale - 200 [Valeur de plage maximale = toIndex - fromIndex] |
* - Paramètre obligatoire
Remarque :
- La méthode getRelatedRecords ne prend pas en charge les champs de recherche personnalisée.
Listes associées prises en charge
La méthode getRelatedRecords prend en charge tous les modules et leurs listes associées respectives, à l'exception des e-mails, des concurrents et des intégrations (Zoho Support, Zoho Projects, etc.).
Exemples
Pour récupérer des prospects liés à une campagne (avec id 121212121)
Format de l'URL :
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
Pour récupérer l'historique des étapes liées à une transaction
Format de l'URL :
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Deals
Pour récupérer des rôles de contact liés à une transaction
Format de l'URL :
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Deals
Pour afficher des fichiers joints à un enregistrement
Format de l'URL :
https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Auth Token&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321
Exemple de réponse
Pour récupérer des notes sous un enregistrement
Format de l'URL :
https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name