Méthode getRecordById
Table des matières
Objectif
Vous pouvez utiliser cette méthode pour récupérer des enregistrements individuels par ID d'enregistrement.
URL de la requête
Format XML :
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
Format JSON :
https://crm.zoho.com/crm/private/json/Leads/getRecordById?&authtoken=Auth Token&scope=crmapi&id=RecordID
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. |
| id* ou idlist* | Chaîne | id: Specify unique ID of the record. idlist : spécifiez un ensemble d'ID unique (séparés par un point-virgule). Vous pouvez spécifier jusqu'à 100 ID à l'aide de ce paramètre. |
| newFormat | Entier (1 ou 2) | newFormat=1 : pour exclure les champs avec des valeurs « null » lors de la récupération de données depuis votre compte CRM. newFormat=2 : pour inclure les champs avec des valeurs « null » lors de la récupération de données depuis votre compte CRM. |
| version | Nombre entier | version = 1 : (valeur par défaut) Cela permettra de récupérer les réponses en fonction de l'API mise en œuvre précédemment, c'est-à-dire avant les améliorations apportées. version = 2 : Cela permettra de récupérer les réponses en fonction de la mise en œuvre de l'API la plus récente. |
* - Paramètre obligatoire
Remarque :
- Consultez la page Notes de publication pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.
Exemples
Pour récupérer des enregistrements par ID, utilisez l'URL indiquée ci-dessous :
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
Pour récupérer des enregistrements par liste d'ID, utilisez l'URL indiquée ci-dessous :
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
Remarque :
- Vous pouvez récupérer des enregistrements en utilisant le paramètre id ou idlist. Utilisez le paramètre « id » pour récupérer les enregistrements d'un ID unique. Utilisez le paramètre « idlist » pour récupérer les enregistrements des ID souhaités.
Pour récupérer des prospects sans spécifier le paramètre newFormat
Remarque :
- Lorsqu'il n'y a pas de spécification sur le format de réponse, la valeur par défaut « 1 » est attribuée au paramètre newFormat, c'est-à-dire newFormat = 1.
Cela renvoie une réponse de type :
Pour récupérer des prospects en spécifiant le paramètre idlist
Cela renvoie une réponse de type :
Programme de test
Vous pouvez utiliser le programme joint pour exécuter et tester le fonctionnement de la méthode getRecordById dans votre environnement Java.
Le programme Java contient les éléments suivants :
- Format de génération de jeton d'authentification
- Paramètres et leurs valeurs
- Utilisation réelle de la méthode
Cliquez ici pour télécharger le programme.