Aide CRM

Méthode getSearchRecords

Table des matières

Objectif

Vous pouvez utiliser cette méthode pour rechercher les enregistrements en fonction des expressions des colonnes sélectionnées.

URL de demande

Format XML :
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

Format JSON :
https://crm.zoho.com/crm/private/json/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

Remarque :

  • Quelle que soit l'édition de Zoho CRM, vous pouvez seulement envoyer 250 demandes d'API/jour. Pour chaque appel, vous pouvez récupérer au maximum 200 enregistrements.

Paramètres de demande

ParamètreType de donnéesDescription
authtoken*ChaîneChaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho.
scope*ChaîneIndiquez crmapi pour l'étendue
selectColumns*ChaîneModule(colonnes facultatives) c.-à.d.Leads(nom,site Web,e-mail) OU All
searchCondition*Chaîne(Créé par|=|nom de l'utilisateur)
newFormatEntiernewFormat=1 : pour exclure les champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM.
newFormat=2 : pour inclure des champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM.
fromIndexEntierValeur par défaut - 1
toIndexEntierValeur par défaut - 20
Valeur maximale - 200
versionEntierversion = 1 : (valeur par défaut) permet de récupérer les réponses en fonction de la version d'API mise en œuvre précédemment, c.-à-d. avant les améliorations apportées.
version = 2 : permet de récupérer les réponses en fonction de l'API la plus récente.

* - Paramètre obligatoire

Remarque :

  • consultez la page des Notes de mise à jour pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.

Expressions régulières

Lorsque vous utilisez cette méthode, assurez-vous que les paramètres selectColumns et searchCondition sont définis comme obligatoires. Vous pouvez indiquer les expressions suivantes dans la demande d'API :

  • est OU =
  • n'est pas OU <>
  • contient (*srcString*)
  • commence par (*srcString)
  • se termine par (*srcString)
  • ne contient pas
  • < OU est avant
  • > OU est après
  • <=
  • =>

Exemples

Exemple 1

Si vous souhaitez sélectionner le nom du leadsa société, son e-mail, son portable, son site Web à partir des leads et si l'e-mail contient « @sample.com », la demande de recherche d'API doit être formulée comme suit :

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCondition=(Email|contains|*@sample.com*)

Exemple 2

Si vous souhaitez sélectionner la société, l'e-mail, le site Web à partir des leads et si le nombre d'employés doit être supérieur à 100, la demande de recherche d'API doit être formulée comme suit :

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)

Exemple 3

Si vous souhaitez sélectionner le nom et l'e-mail du Lead à partir des leads et si la société doit commencer par « Zoho », la demande de recherche d'API doit alors être formulée comme ci-dessous :

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|Zoho*)

Exemple avec égal à (=)

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)&searchCondition=(Email|=|test@test.com)

Exemple avec supérieur à (>)

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Annual Revenue|>|1000)

Exemple avec inférieur à (<)

Remarque :

  • Remplacez les champs d'entier de valeur « null » avec « 0 ». Les champs d'entier sans valeur ne seront pas inclus dans la recherche.

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(customfield1|<|1000)

Exemple avec contient

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|contains|*oho*)

Exemple avec commence par

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|starts with|zoho*)

Exemple avec se termine par

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|ends with|*zoho)

Exemple avec equal(=) et selectColumns=All

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=All
&searchCondition=(Email|=|test@test.com)

Programme de test

Vous pouvez utiliser le programme ci-joint pour exécuter et tester le fonctionnement de la méthode getSearchRecords dans votre environnement Java.

Le programme Java contient les éléments suivants :

  • format de génération du jeton d'authentification
  • paramètres et leurs valeurs
  • utilisation réelle de la méthode

Cliquez ici pour télécharger le programme

Share this post : FacebookTwitter

Vous ne trouvez toujours pas ce que vous cherchez?

Écrivez-nous: support@zohocrm.com