Komplexe REST-API-Strukturen im Jitterbit App Builder

Übersicht

Die REST-API des App Builders unterstützt komplexe REST-API-Strukturen für GET-Operationen. Dies ermöglicht es, 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 nicht unterstützt.

Konfiguration

Navigieren Sie zu App Builder IDE > Ihr Unternehmen erweitern > Veröffentlichen
Erstellen Sie Ihren REST-Endpunkt wie gewohnt mit Ihrer Stamm-Tabelle/-Endpunkt
Klicken Sie auf das Struktur-Symbol für Ihren Endpunkt
Fügen Sie bei Bedarf untergeordnete Ressourcen hinzu

Ressourcenparameter

Name	Beschreibung
Parent	Die übergeordnete Tabelle in der Hierarchie.
Name	Der Name dieses Knotens in der Baumstruktur. Beachten Sie, dass der Name Vorwärtsschrägstriche enthalten kann, um die Struktur noch tiefer zu verschachteln.
Table	Die Tabelle, aus der Daten abgerufen werden sollen.
Field Type	Der Typ des Feldes. Array von Objekten: Dies ist der Standardtyp, bei dem jede Zeile in der Tabelle ein JSON-Objekt ist. Array von Skalaren: Ein Array von Einzelwert-Elementen, serialisiert zu einem JSON-Array von Skalaren. Die Tabelle muss `Index`- und `Value`-Spalten enthalten. Objekt: Entspricht einem einzelnen JSON-Objekt (was effektiv das JSON-Array eliminiert). Die Tabelle sollte höchstens eine Zeile zurückgeben.
Expand By Default	Wenn wahr, wird die Tabelle standardmäßig erweitert (im Ausgabe-JSON angezeigt). Wenn falsch, muss der REST-Aufrufer eine `$expand=true`-Abfragezeichenfolgen-Eigenschaft bereitstellen, um die Daten zu sehen Beachten Sie, dass diese Eigenschaft nur eine Sammlung von Anfragen beeinflusst (z. B. `/orders`). Eine Anfrage für ein bestimmtes Element in einer Sammlung (z. B. `/orders/101`) wird immer untergeordnete Tabellen erweitern.
Get Max Limit	Wenn angegeben, gibt es das maximale Limit der Elemente an, die in einer `GET`-Anfrage zurückgegeben werden können. Wenn NULL, wird der Standardmaximalwert für die REST-API verwendet.
Resource Bindings	Stellt die Bindungen zwischen den übergeordneten und untergeordneten Tabellen ein.

Änderungen an den Abfrageparametern

Die folgenden Abfrageparameter wurden geändert, um mit komplexen REST-API-Strukturen zu arbeiten:

$fields ermöglicht es Ihnen, Kindtabellen anzugeben
- Z. B. details/*: Alle Felder der Kindtabelle details
- Z. B. details/name: Nur das Feld name der Kindtabelle details
- Z. B. *: Alle Felder in allen Tabellen
$expand ein Wahr/Falsch-Parameter, der hinzugefügt wurde, um dem REST-Aufrufer zu ermöglichen, Tabellen zu erweitern, die standardmäßig nicht erweitert sind (oder umgekehrt). Wird nur für Sammlungsanfragen verwendet.
- Z. B. $expand=true