Zum Inhalt springen

Komplexe REST- API Strukturen im Jitterbit App Builder

Übersicht

Neu in VInyl 2.6: App Builders REST- API unterstützt jetzt komplexe REST- API-Strukturen für GET Operationen. Mit dieser Erweiterung ist es nun möglich, Daten aus mehreren Tabellen abzurufen 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 die Daten abgerufen werden sollen.
Feldtyp Der Feldtyp.
  • Objekt-Array: Dies ist der Standardtyp, bei dem jede Zeile in der Tabelle ein JSON-Objekt ist.
  • Skalar-Array: Ein Array aus Einzelwertelementen, serialisiert in ein JSON-Skalar-Array. Die Tabelle muss enthalten Index Und Value Spalten.
  • Objekt: Wird einem einzelnen JSON-Objekt zugeordnet (wodurch das JSON-Array effektiv eliminiert wird). Die Tabelle sollte höchstens eine Zeile zurückgeben.
Standardmäßig erweitern Wenn „true“, wird die Tabelle standardmäßig erweitert (wird im JSON-Ausgabefenster angezeigt). Wenn „false“, 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 in einer Sammlung (z. B. /orders/101) erweitert immer untergeordnete Tabellen.
Maximales Limit abrufen Gibt, falls angegeben, das maximale Limit an Artikeln an, die in einem GET Anfrage. 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 die Angabe untergeordneter Tabellen.
    • Z. B. details/*: Alle Felder des details Untertabelle
    • Z. B. details/name: Nur die name Feld der details Untertabelle
    • Z. B. *: Alle Felder in allen Tabellen
  • $expand Ein Wahr/Falsch-Parameter wurde hinzugefügt, um dem REST-Aufrufer das Erweitern von Tabellen zu ermöglichen, die standardmäßig nicht erweitert sind (oder umgekehrt). Wird nur für Sammlungsanfragen verwendet.
    • Z. B. $expand=true