CRM-Hilfe

getSearchRecords-Methode

Inhaltsverzeichnis

Zweck

Mit dieser Methode können Sie Datensätze anhand von Ausdrücken der ausgewählten Spalten zu suchen.

Anfrage-URL

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

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

Hinweis:

  • Unabhängig von der Zoho CRM Edition können Sie nur 250 API-Anfragen/Tag senden. Mit jedem Aufruf können maximal 200 Datensätze abgerufen werden.

Anfrageparameter

ParameterDatentypBeschreibung
authtoken*ZeichenfolgeVerschlüsselte alphanumerische Zeichenfolge zur Authentifizierung Ihrer Zoho-Anmeldedaten.
scope*ZeichenfolgeLegen Sie crmapi für "scope" fest.
selectColumns*ZeichenfolgeModul(optionale Spalten), z. B. Leads(Nachname,Website,E-Mail) ODER "All"
searchCondition*Zeichenfolge(Created By|=|username)
newFormatGanzzahlnewFormat=1: Um Felder mit dem Wert "Null" beim Einfügen von Daten aus Ihrem CRM-Konto auszuschließen.
newFormat=2: Um Felder mit dem Wert "Null" beim Einfügen von Daten aus Ihrem CRM-Konto einzubeziehen.
fromIndexGanzzahlStandardwert – 1
toIndexGanzzahlStandardwert – 20
Maximaler Wert – 200
versionGanzzahlVersion = 1: (Standardwert) Dadurch werden Antworten auf der Grundlage der früheren API-Implementierung abgerufen, d. h. vor den vorgenommenen Erweiterungen/Verbesserungen.
Version = 2: Dadurch werden Antworten basierend auf der neuesten API-Implementierung abgerufen.

* – Obligatorischer Parameter

Hinweis:

  • Auf der Seite Versionshinweise erfahren Sie mehr über die Erweiterungen/Verbesserungen, die in der API-Implementierung vorgenommen wurden.

Reguläre Ausdrücke

Stellen Sie bei der Verwendung dieser Methode sicher, dass die Parameter selectColumns und searchCondition als obligatorisch festgelegt wurden. Sie können die folgenden Ausdrücke in API-Anfragen angeben:

  • is OR =
  • isn't OR <>
  • contains(*srcString*)
  • starts with(srcString*)
  • ends with(*srcString)
  • doesn't contain
  • < OR is before
  • > OR is after
  • <=
  • =>

Beispiele

Beispiel 1

Wenn Sie Lead-Name, Unternehmen, E-Mail, Mobiltelefon und Website aus den Leads auswählen möchten und die E-Mail "@sample.com" enthalten soll, muss die API-Suchanfrage wie folgt angegeben werden:

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*)

Beispiel 2

Wenn Sie Unternehmen, E-Mail, und Website aus den Leads auswählen möchten und die Anzahl der Mitarbeiter größer als 100 sein soll, muss die API-Suchanfrage wie folgt angegeben werden:

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)

Beispiel 3

Wenn Sie Lead-Name und E-Mail aus den Leads auswählen möchten und das Unternehmen mit "Zoho" beginnen soll, muss die API-Suchanfrage wie folgt angegeben werden:

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*)

Beispiel mit "Gleich" (=)

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)

Beispiel mit "Größer als" (>)

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)

Beispiel mit "Kleiner als" (<)

Hinweis:

  • Ersetzen Sie Felder vom Typ "Ganzzahl", die den Wert "Null" enthalten, durch "0". Felder vom Typ "Ganzzahl" können nur dann in der Suche berücksichtigt werden, wenn sie einen Wert enthalten.

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)

Beispiel mit "Enthält"

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*)

Beispiel mit "Beginnt mit"

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*)

Beispiel mit "Endet mit"

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)

Beispiel mit "Gleich" (=) und selectColumns=All

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

Testprogramm

Mit dem beigefügten Programm können Sie die Funktion der getSearchRecords-Methode in Ihrer Java-Umgebung ausführen und testen.

Das Java-Programm enthält Folgendes:

  • Format der authtoken-Generierung
  • Parameter und ihre Werte
  • Tatsächliche Anwendung der Methode

Klicken Sie hier, um das Programm herunterzuladen.

Share this post : FacebookTwitter

Finden Sie immer noch nicht, wonach Sie suchen?

Schreib uns: support@zohocrm.com