Komplexe REST- API -Strukturen im Jitterbit App Builder
Übersicht
Neu in Vinyl 2.6, App Builder Die REST- API von unterstützt jetzt komplexe REST- API-Strukturen für GET
Operationen. Mit dieser Erweiterung ist es jetzt möglich, Daten aus mehreren Tabellen anzufordern und die Ergebnisse in einer einzigen zurückgegebenen JSON-Struktur zu verschachteln.
Hinweis
Andere HTTP-Methoden wie POST
Und PUT
werden derzeit nicht unterstützt.
Konfiguration
- Navigieren Sie zu App Builder IDE > Erweitern Sie Ihr Unternehmen > Veröffentlichen
- Erstellen Sie Ihren REST- Endpoint wie gewohnt mit Ihrer Stammtabelle/ Endpoint
- Klicken Sie auf das Struktur-Symbol für Ihren Endpoint
- Fügen Sie untergeordnete Ressourcen nach Bedarf hinzu
Ressourcenparameter
Name | Beschreibung |
---|---|
Übergeordnet | Die übergeordnete Tabelle in der Hierarchie. |
Name | Der Name dieses Knotens in der Baumstruktur. Beachten Sie, dass der Name Schrägstriche enthalten kann, um die Struktur noch tiefer zu verschachteln. |
Tabelle | Die Tabelle, aus der Daten abgerufen werden sollen. |
Feldtyp | Der Feldtyp.
|
Standardmäßig erweitern | Wenn wahr, wird die Tabelle standardmäßig erweitert (wird im Ausgabe-JSON angezeigt). Wenn falsch, muss der REST-Aufrufer eine $expand=true Abfrage zum Anzeigen der Daten Beachten Sie, dass diese Eigenschaft nur Auswirkungen auf eine Sammlungsanforderung hat (z. B. /orders ). Eine Anfrage für ein bestimmtes Element einer Sammlung (z. B. /orders/101 ) erweitert immer untergeordnete Tabellen. |
Maximales Limit abrufen | Gibt, sofern angegeben, das maximale Limit an Artikeln an, die in einem GET Anforderung. Wenn NULL, wird der standardmäßige Maximalwert für die REST- API verwendet. |
Ressourcenbindungen | Richtet die Bindungen zwischen den übergeordneten und untergeordneten Tabellen ein. |
Änderungen an Abfrage
Die folgenden Abfrage wurden geändert, um mit komplexen REST- API -Strukturen zu funktionieren:
$fields
ermöglicht Ihnen, untergeordnete Tabellen anzugeben- Z. B.
details/*
: Alle Felder desdetails
untergeordnete Tabelle - Z. B.
details/name
: Nur diename
Feld derdetails
untergeordnete Tabelle - Z. B.
*
: Alle Felder in allen Tabellen
- Z. B.
$expand
ein True/False-Parameter, der hinzugefügt wurde, um dem REST-Aufrufer das Erweitern von Tabellen zu ermöglichen, die standardmäßig nicht erweitert sind (oder umgekehrt). Wird nur für Sammlungsanforderungen verwendet.- Z. B.
$expand=true
- Z. B.