getMyRecords-Methode

getMyRecords-Methode

Zweck

Sie können die getMyRecords-Methode verwenden, um Daten durch den Eigentümer des Authentifizierungstoken, der in der API-Anfrage angegeben ist, abzurufen.

Anfrage-URL

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

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

Anfrageparameter

ParameterDatentypBeschreibung
authtoken*ZeichenfolgeVerschlüsselte alphanumerische Zeichenfolge zur Authentifizierung Ihrer Zoho-Anmeldedaten.
scope*ZeichenfolgeGeben Sie den Wert als crmapi an.
selectColumnsZeichenfolgeZum Auswählen der erforderlichen Felder aus dem CRM-Modul.
Format: Modul(optionale Spalten)
Beispiel: Leads(Nachname,Website,E-Mail) ODER "All"
fromIndexGanzzahlStandardwert – 1
toIndexGanzzahlStandardwert – 20
Maximaler Bereichswert – 200
[Maximaler Bereichswert = toIndex - fromIndex]
sortColumnStringZeichenfolgeWählen Sie eines der Felder in CRM zum Sortieren der Daten aus.
Beispiel: sortColumnString=Company
In diesem Fall werden die Daten basierend auf dem Feld Company sortiert.
sortOrderStringZeichenfolgeSortierreihenfolge: asc (für aufsteigend) oder desc (für absteigend).
Wenn Sie den Parameter sortColumnString verwenden, werden die Daten standardmäßig in aufsteigender Reihenfolge sortiert.
lastModifiedTimejjjj-MM-tt HH:mm:ssStandardwert: Null
Wenn Sie die Zeit angeben, werden die erstellten/geänderten Daten nach der konfigurierten Zeit abgerufen.
newFormatGanzzahl (1 oder 2)newFormat=1: Um Felder mit dem Wert "Null" beim Abrufen von Daten aus Ihrem CRM-Konto auszuschließen.
newFormat=2: Um Felder mit dem Wert "Null" beim Abrufen von Daten aus Ihrem CRM-Konto einzubeziehen.
versionGanzzahl

Version = 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.

Aktuelle Version ist 4.

* – Obligatorischer Parameter

Hinweis:

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

Fehlercodes

Hier finden Sie Informationen zu den Fehlercodes.

Zusätzliche Hinweise

  • Beim Abrufen von Daten aus Ihrem Zoho CRM-Account wird die rollenbasierte Sicherheit (Rollen, Profile, Sicherheit auf Feldebene und die Datenfreigaberegeln) angewendet. Informationen zu rollenbasierten Sicherheitseinstellungen finden Sie unter Sicherheitsadministration.
  • fromIndex und toIndex sind optionale Parameter. Standardmäßig sind fromIndex = 1 und toIndex = 20.
  • sortColumnString und sortOrderString sind ebenfalls optionale Parameter.
  • Der Wert für den Parameter lastModifiedTime muss im Format jjjj-MM-tt HH:mm:ss vorliegen.

Beispiele

Leads-Daten aus Zoho CRM abrufen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?newFormat=1&authtoken=Auth Token&scope=crmapi

Um Daten von anderen Modulen abzurufen, ersetzen Sie Leads durch Accounts, Contacts, Potentials, usw.

Über 200 Datensätze abrufen

Standardmäßig können Sie 20 Datensätze pro Stapel abrufen. Durch die Verwendung des toIndex-Parameters können Sie jedoch bis zu 200 Datensätze pro Stapel abrufen. Wenn Sie über 200 Datensätze abrufen möchten, gehen Sie wie folgt vor:

Iteration 1: fromIndex=1&toIndex=200
Iteration 2: fromIndex=201&toIndex=400

Leads mit dem Namen des Unternehmens in aufsteigender Reihenfolge abrufen

sortColumnString=Company&sortOrderString=asc

Leads mit dem Namen des Unternehmens in absteigender Reihenfolge abrufen

sortColumnString=Company&sortOrderString=desc

Leads ohne Angabe des newFormat-Parameters abrufen

Hinweis:

  • Wenn keine Angaben zum Antwortformat vorliegen, wird dem Parameter newFormat der Standardwert "1" zugewiesen, d. h. newFormat = 1.

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)

Diese Suche gibt folgende Antwort aus:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>

Leads mit newFormat=2 abrufen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)

Diese Suche gibt folgende Antwort aus:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>
</Leads>

Die ersten 25 Leads aus Zoho CRM abrufen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&fromIndex=1&toIndex=25

Leads mit dem lastModifiedTime-Parameter abrufen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23

Hinweis:

  • Wenn Sie die Zeit angeben, werden die geänderten Daten nach der konfigurierten Zeit abgerufen.

Alle Felder aus Leads mit newFormat=1 auswählen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All

Hinweis:

  • Dadurch werden alle Felder mit Werten ausgegeben.

Alle Felder aus Leads mit newFormat=2 auswählen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All

Hinweis:

  • Dadurch werden alle Felder, einschließlich der Felder mit dem Wert "Null", ausgegeben.

Leads mit den Parametern lastModifiedTime, fromIndex und toIndex abrufen

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23 &fromIndex=1&toIndex=25

Testprogramm

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

Das Java-Programm enthält Folgendes:

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

Share this post : FacebookTwitter

Finden Sie immer noch nicht, wonach Sie suchen?

Schreib uns: support@zohocrm.com