getRecordById-Methode
Inhaltsverzeichnis
Zweck
Mit dieser Methode können Sie einzelne Datensätze nach Datensatz-ID abrufen.
Anfrage-URL
XML-Format:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
JSON-Format:
https://crm.zoho.com/crm/private/json/Leads/getRecordById?&authtoken=Auth Token&scope=crmapi&id=RecordID
Anfrageparameter
| Parameter | Datentyp | Beschreibung |
| authtoken* | Zeichenfolge | Verschlüsselte alphanumerische Zeichenfolge zur Authentifizierung Ihrer Zoho-Anmeldedaten |
| scope* | Zeichenfolge | Geben Sie den Wert als crmapi an. |
| id* oder idlist* | Zeichenfolge | id: Specify unique ID of the record. idlist: Geben Sie einen eindeutigen Satz von IDs an (getrennt durch Semikolon). Mit diesem Parameter können Sie bis zu 100 IDs angeben. |
| newFormat | Ganzzahl (1 oder 2) | newFormat=1: Ausschließen von Feldern ohne Werte beim Abrufen von Daten aus Ihrem CRM-Konto.newFormat=2: Einschließen von Feldern ohne Werte beim Abrufen von Daten aus Ihrem CRM-Konto. |
| 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.
Beispiele
Um Datensätze nach ID abzurufen, verwenden Sie die unten angegebene URL:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
Um Datensätze nach ID-Liste abzurufen, verwenden Sie die unten angegebene URL:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
Hinweis:
- Sie können Datensätze entweder über den id- oder idlist-Parameter abrufen. Verwenden Sie den Parameter "id", um Datensätze einer eindeutigen ID abzurufen. Verwenden Sie den Parameter "idlist", um Datensätze der gewünschten IDs abzurufen.
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:
Leads unter Angabe des idlist-Parameters abrufen
Es wird eine Antwort wie unten gezeigt zurückgegeben:
Testprogramm
Mit dem beigefügten Programm können Sie die Funktion der getRecordById-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
Klicken Sie hier, um das Programm herunterzuladen.