getRecords-Methode
Inhaltsverzeichnis
- Zweck
- Anfrage-URL
- Anfrageparameter
- Erfassen von Fehlern
- Beispiele
- Alle Konten im JSON-Format, sortiert nach Kontoname (in absteigender Reihenfolge), beginnend mit 20 bis 200, abrufen
- Alle Konten im XML-Format abrufen, die nach 2008-05-27 00:00:00 geändert/erstellt wurden
- Leads mit Version = 1 abrufen
- Leads mit Version = 2 abrufen
- Leads ohne Angabe des newFormat-Parameters abrufen
- Mit newFormat=2 abrufen
- Mit fromIndex=1, toIndex=25 abrufen
- Mit lastModifiedTime abrufen
- Alle Felder aus Leads mit newFormat=1 auswählen
- Alle Felder aus Leads mit newFormat=2 auswählen
- Mit lastModifiedTime, fromIndex und toIndex abrufen
- Mit lastModifiedTime, fromIndex und toIndex (für das "Accounts"-Modul) abrufen
- Testprogramm
Zweck
Mit der getRecords-Methode können Sie alle in der API-Anfrage angegebenen Benutzerdaten abrufen.
Anfrage-URL
XML-Format:
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
JSON-Format:
https://crm.zoho.com/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Anfrageparameter
| Parameter | Datentyp | Beschreibung |
| authtoken* | Zeichenfolge | Verschlüsselte alphanumerische Zeichenfolge zur Authentifizierung Ihrer Zoho-Anmeldedaten |
| scope* | Zeichenfolge | Geben Sie den Wert als crmapi an. |
| selectColumns | Zeichenfolge | Modul (optionale Spalten), z. B. Leads (Nachname, Website, E-Mail) ODER Alle |
| fromIndex | Ganzzahl | Standardwert: 1 |
| toIndex | Ganzzahl | Standardwert: 20 Maximaler Bereichswert: 200 [Maximaler Bereichswert = toIndex - fromIndex] |
| sortColumnString | Zeichenfolge | Wenn Sie den Parameter sortColumnString verwenden, werden die Daten standardmäßig in aufsteigender Reihenfolge sortiert. |
| sortOrderString | Zeichenfolge | Standardwert: asc Wenn Sie absteigend sortieren möchten, müssen Sie sortOrderString=desc auswählen. |
| lastModifiedTime | dateTime | Standardwert: null Wenn Sie die Zeit angeben, werden die geänderten Daten nach der konfigurierten Zeit abgerufen. |
| newFormat | Ganzzahl | newFormat=1: Felder ohne Werte ausschließen, während Sie Daten aus Ihrem CRM-Konto einfügen newFormat=2:Felder ohne Werte beim Einfügen von Daten aus Ihrem CRM-Konto einfügen |
| version | Ganzzahl | version = 1: (Standard) Antworten basierend auf der früheren API-Implementierung abrufen, d. h. vor den vorgenommenen Verbesserungen version=2: Antworten basierend auf der neuesten API-Implementierung abrufen |
* – Pflichtparameter
Hinweis:
- Auf der Seite Versionshinweise erfahren Sie mehr über die Verbesserungen, die in der API-Implementierung vorgenommen wurden.
Erfassen von Fehlern
Die CRM-API bietet eindeutige Fehlercodes, um Probleme in Ihrem Programm zu beheben und gleichzeitig Daten zwischen CRM und Ihrer Anwendung zu synchronisieren. Um mehr über die verschiedenen Fehlercodes und die entsprechenden Definitionen zu erfahren, lesen Sie bitte die Fehlercodes.
Zusätzliche Anmerkungen
- Beim Abrufen von Daten aus Ihrem Zoho CRM werden die Sicherheitseinstellungen des Benutzers auf Feldebene angewendet. Um alle Benutzerdaten abzurufen, verwenden Sie daher die Benutzer-ID mit der höchsten Rolle (Bsp.: CEO) und dem höchsten Profil (Bsp.: Administrator).
- 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
Alle Konten im JSON-Format, sortiert nach Kontoname (in absteigender Reihenfolge), beginnend mit 20 bis 200, abrufen
URL-Format:
Alle Konten im XML-Format abrufen, die nach 2008-05-27 00:00:00 geändert/erstellt wurden
URL-Format:
Leads mit Version = 1 abrufen
Leads mit Version = 2 abrufen
Es wird eine Antwort wie unten gezeigt zurückgegeben:
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
Es wird eine Antwort wie unten gezeigt zurückgegeben:
Mit newFormat=2 abrufen
Mit fromIndex=1, toIndex=25 abrufen
Hinweis:
- Dadurch werden 1 bis 25 Datensätze zurückgegeben.
Mit lastModifiedTime abrufen
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
Hinweis:
- Dies gibt alle Felder mit Werten zurück.
Alle Felder aus Leads mit newFormat=2 auswählen
Hinweis:
- Dies gibt alle Felder zurück, einschließlich Nullwertfelder.
Mit lastModifiedTime, fromIndex und toIndex abrufen
Mit LastModifiedTime, fromIndex und toIndex (für das "Accounts"-Modul) abrufen
Testprogramm
Mit dem beigefügten Programm können Sie die Funktion der getRecords-Methode in Ihrer Java-Umgebung ausführen und testen.
Das Java-Programm enthält Folgendes:
- Format der Tokengenerierung
- Parameter und ihre Werte
- Tatsächliche Anwendung der Methode
Klicken Sie hier, um das Programm herunterzuladen.