getRelatedRecords-Methode
Inhaltsverzeichnis
- Zweck
- Anfrage-URL
- Anfrageparameter
- Unterstützte verwandte Listen
- Beispiele
- Leads im Zusammenhang mit einer Kampagne abrufen (mit der ID 1212121212121)
- Den Stufenverlauf im Zusammenhang mit einem Geschäftsabschluss abrufen
- Kontaktrollen im Zusammenhang mit einem Geschäftsabschluss abrufen
- Dateien anzeigen, die an einen Datensatz angehängt sind
- Notizen zu einem Datensatz abzurufen
Zweck
Sie können die getRelatedRecords-Methode verwenden, um verwandte Datensätze abzurufen.
Beispiel: Sie können Leads im Zusammenhang mit einer Kampagne oder Aufgaben im Zusammenhang mit einem Konto abrufen.
Anfrage-URL
XML-Format:
https://crm.zoho.com/crm/private/xml/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
JSON-Format:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=Record ID&parentModule=Module Name
Anfrageparameter
| Parameter | Datentyp | Beschreibung |
| authtoken* | Zeichenfolge | Verschlüsselte alphanumerische Zeichenfolge zur Authentifizierung Ihrer Zoho-Anmeldedaten |
| scope* | Zeichenfolge | Geben Sie den Wert als crmapi an. |
| parentModule* | Zeichenfolge | Modul, für das Sie die verwandten Datensätze abrufen möchten Beispiel: Wenn Sie Leads im Zusammenhang mit einer Kampagne abrufen möchten, dann ist "Campaigns" Ihr übergeordnetes Modul. |
| id* | Ganzzahl | Die ID des Datensatzes, für den Sie verwandte Datensätze abrufen möchten |
| 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 |
| fromIndex | Ganzzahl | Standardwert: 1 |
| toIndex | Ganzzahl | Standardwert: 20 Maximaler Bereichswert: 200 [Maximaler Bereichswert = toIndex - fromIndex] |
* – Pflichtparameter
Hinweis:
- Die getRelatedRecords-Methode unterstützt keine benutzerdefinierten Suchfelder.
Unterstützte verwandte Listen
Die getRelatedRecords-Methode unterstützt alle Module und die dazugehörigen Listen mit Ausnahme von E-Mails, Mitbewerbern und Integrationen (Zoho Support, Zoho Projects usw.)
Beispiele
Leads im Zusammenhang mit einer Kampagne abrufen (mit der ID 1212121212121)
URL-Format:
https://crm.zoho.com/crm/private/json/Leads/getRelatedRecords?newFormat=1&authtoken=sbdjEDBDJ1323&scope=crmapi&parentModule=Campaigns&id=121212121
Den Stufenverlauf im Zusammenhang mit einem Geschäftsabschluss abrufen
URL-Format:
https://crm.zoho.com/crm/private/xml/PotStageHistory/getRelatedRecords?authtoken=Auth Token&scope=crmapi&id=468939000000054013&parentModule=Deals
Kontaktrollen im Zusammenhang mit einem Geschäftsabschluss abrufen
URL-Format:
https://crm.zoho.com/crm/private/xml/ContactRoles/getRelatedRecords?authtoken=Auth Token&scope=crmapi
&id=468939000000054013&parentModule=Deals
Dateien anzeigen, die an einen Datensatz angehängt sind
URL-Format:
https://crm.zoho.com/crm/private/xml/Attachments/getRelatedRecords?authtoken=Your Authentifizierungstoken&newFormat=1&scope=crmapi&parentModule=Leads&id=508020000000957321
Beispielantwort
Notizen zu einem Datensatz abzurufen
URL-Format:
https://crm.zoho.com/crm/private/xml/Notes/getRelatedRecords?authtoken=<Your Authtoken>&scope=crmapi&id=RECORD_ID&parentModule=Module Name