REST-Objekt im Jitterbit App Builder

Übersicht

Mit REST-Objekten können App Builder Entwickler REST- APIs ähnlich wie mit App Builder Datenobjekten nutzen. REST-Objekte unterstützen Folgendes:

• CRUD-Operationen
• Integration mit verschiedenen App Builder Steuerelementen wie mehrzeiligen/einzeiligen Bedienfeldern, Listen
• Benutzerdefinierte Ereignisse
• Sortieren
• Filtern (Abfrage im OData-Stil)

Für REST- APIs, die Operationen im CRUD-Stil unterstützen, kann die Konfiguration eines REST-Objekts eine einfache Möglichkeit sein, eine API in Ihre App Builder App zu integrieren.

CRUD Endpoints

Für eine REST- API im CRUD-Stil müssen Sie Endpoints konfigurieren, die das Erstellen, Lesen, Aktualisieren und Löschen von Datensätzen ermöglichen. Im Allgemeinen bedeutet dies die Einrichtung der folgenden Endpoints:

Beispielkonfiguration der App Builder REST API

Die folgenden Schritte zeigen, wie Sie CRUD Endpoints für einen App Builder REST-Server konfigurieren. In diesem Beispiel gehen wir von einer Tabelle wie der folgenden aus:

Diese REST- API wird vom Endpoint „Northwinds“ als Ressource namens „Customers“ bereitgestellt. Die URL für diesen Endpoint lautet daher:

https://api.example.com/rest/v1/northwinds/customers

Stellen Sie sicher, dass Sie die REST- API auf Ihrem Server eingerichtet und die REST-Datenquelle erstellt haben, bevor Sie fortfahren.

Lese Endpoint

• Navigieren Sie zu IDE > Datenserver > Ihr REST-Datenserver > Details
• Klicken Sie im Bereich Endpoint auf + Endpoints und konfigurieren Sie die folgenden Informationen:
  • Name: Kunden (erhalten)
  • Endpoint: Kunden
  • Methode: GET
• Klicken Sie auf Speichern
• Klicken Sie auf Entdecken
• Zurück zur vorherigen Seite
• Wählen Sie Ihren Kunden (get)- Endpoint
• Beachten Sie, dass es drei Ausgabetabellen gibt
• Doppelklicken Sie auf die Tabelle customers (get)/items
• Legen Sie die Spalte customerId als Primärschlüssel fest
• Stellen Sie sicher, dass die Spalten den erwarteten Speichertyp verwenden
• Klicken Sie auf Ergebnisse und überprüfen Sie, ob die zurückgegebenen Daten den Erwartungen entsprechen.

Erstellen

• Navigieren Sie zu IDE > Datenserver > Ihr REST-Datenserver > Details

• Klicken Sie im Bereich Endpoint auf + Endpoints und konfigurieren Sie die folgenden Informationen

  • Name: Kunden (einfügen)
  • Endpoint: Kunden
  • Methode: POST

  • Beispiel-Eingabe - App Builder erwartet die Eingabe im folgenden Format:

    {
      "item": {
        "customerId": "abcde",
        "name": "Test Customer",
        "daysActive": 10
      }
    }
    

• Klicken Sie auf Speichern

• Klicken Sie auf Entdecken
  • Beachten Sie, dass mehrmaliges Klicken auf „Entdecken“ zu einer Verletzung des Primärschlüssels führen kann, da der Datensatz „abcde“ bereits auf dem Server vorhanden ist. In diesem Fall müssen Sie den vorhandenen Datensatz löschen, bevor „Entdecken“ funktioniert. Löschen Sie den Datensatz entweder auf dem App Builder REST API Server oder richten Sie den Endpoint„Löschen“ ein und importieren Sie ihn.
• Zurück zur vorherigen Seite
• Wählen Sie den Endpoint Ihres Kunden (einfügen)
• Doppelklicken Sie auf die Tabelle Kunden (Einfügen)
• Legen Sie die Spalte customerId als Primärschlüssel fest
• Legen Sie die Spalten customerId, name und daysActive auf die Richtung Eingabe/Ausgabe fest.
  • Beim Erstellen eines Datensatzes übergeben wir alle drei Spalten (Eingabe). Der App Builder REST API Server gibt diese Spalten im zurückgegebenen JSON-Format aus (Ausgabe). Sollte der Server aus irgendeinem Grund einen anderen Wert als den von uns gesendeten zurückgeben (z. B. aufgrund der Formatierung einer Zeichenfolge), soll unser Datensatz die zurückgegebenen Werte enthalten.
• Stellen Sie sicher, dass die Spalten den erwarteten Speichertyp verwenden

Aktualisieren

• Navigieren Sie zu IDE > Datenserver > Ihr REST-Datenserver > Details
• Klicken Sie im Bereich Endpoint auf + Endpoints und konfigurieren Sie die folgenden Informationen
• Name: Kunden (Update)
• Endpoint: Kunden/{{item/customerId}}
• Methode: POST

• Beispiel-Eingabe - App Builder erwartet die Eingabe im folgenden Format:

  {
    "item": {
      "customerId": "abcde",
      "name": "Test Customer (updated)",
      "daysActive": 10
    }
  }
  

• Klicken Sie auf Speichern

• Klicken Sie auf Entdecken
• Zurück zur vorherigen Seite
• Wählen Sie Ihren Kunden (Update)- Endpoint
• Doppelklicken Sie auf die Tabelle Kunden (Aktualisieren)
• Legen Sie die Spalte customerId als Primärschlüssel fest
• Legen Sie die Spalten customerId, name und daysActive auf die Richtung Eingabe/Ausgabe fest.
• Stellen Sie sicher, dass die Spalten den erwarteten Speichertyp verwenden

REST-Objekt

Sobald Ihre CRUD- Endpoints konfiguriert sind, können Sie das REST-Objekt erstellen.

REST-Objekt erstellen

• Navigieren Sie zu IDE > Datenserver > Ihr REST-Datenserver > Details
• Klicken Sie auf Mehr > Superobjekte
• Klicken Sie auf + REST-Objekt
• Benennen Sie Ihr REST-Objekt … wir gehen von Kunden aus
• Klicken Sie auf das Häkchen, um zu speichern
• Klicken Sie auf das Bleistift-Bearbeitungssymbol
• Aktivieren Sie Einfügen, Aktualisieren und Löschen durch Klicken auf die entsprechenden Optionen
• Klicken Sie auf „Weiter“ oder auf das Häkchen, um zu speichern

Konfigurieren Sie einzelne Comp

• Klicken Sie auf das Symbol Datensatz öffnen für das REST-Objekt.
• Klicken Sie auf das Symbol Einzelne Komposition.
• Fügen Sie die Tabelle Kunden (get)/Artikel zum Tabellenbereich hinzu.
• Klicken Sie auf das "*" Klicken Sie auf die Schaltfläche, um alle Spalten hinzuzufügen.
• Doppelklicken Sie auf die Spalte customerId und legen Sie sie als Primärschlüssel fest.
• Gehen Sie die einzelnen Spalten einzeln durch und legen Sie den Logischen Datentyp entsprechend fest.
• Beachten Sie: Wenn Sie auf Ergebnisse klicken, bevor Sie die Viele-Komposition (siehe unten) eingerichtet haben, erhalten Sie die Fehlermeldung „Keine Sequenz“. Sie müssen zuerst das Viele-Objekt konfigurieren.
• Kehren Sie zum Bildschirm REST-Objekte zurück.

Konfigurieren Sie viele Comp

• Klicken Sie auf das Symbol „Viele Komp.“.
• Fügen Sie die Tabelle „Kunden (get)/Artikel“ zum Tabellenbereich hinzu.
• Klicken Sie auf das Symbol "*" Klicken Sie auf die Schaltfläche, um alle Spalten hinzuzufügen.
• Legen Sie die Ziel-Spalten auf die entsprechenden Spaltennamen fest.
• Doppelklicken Sie auf die Spalte customerId und legen Sie sie als Primärschlüssel fest.
• Klicken Sie auf Ergebnisse und überprüfen Sie, ob die entsprechenden Daten angezeigt werden.
• Kehren Sie zum Bildschirm REST-Objekte zurück.

Konfigurieren von CRUD Endpoints

Konfigurieren Sie für jede CRUD Operation den Endpoint und die Bindungen gemäß der folgenden Tabelle:

Sie sollten nun in Ihrem REST-Objekt auf die Schaltfläche „Ergebnisse“ klicken und Zeilen hinzufügen, löschen oder aktualisieren können.

Benutzerdefinierte Ereignisse

REST-Objekte können benutzerdefinierte Ereignisse ähnlich wie andere App Builder Datenobjekte definieren. Um Ihrem REST-Objekt ein benutzerdefiniertes Ereignis hinzuzufügen, müssen Sie Folgendes tun:

• Erstellen Sie einen benutzerdefinierten Endpoint
• Erstellen Sie eine CRUD-Regel zum Einfügen in den Endpoint
  • Sie benötigen eine Anwendung, die mit der Datenquelle konfiguriert ist
• Fügen Sie dem REST-Objekt ein benutzerdefiniertes Ereignis hinzu

Erstellen eines benutzerdefinierten Endpoint

Im App Builder kann ein benutzerdefiniertes Ereignis für eine Tabelle mithilfe dieser URL Notation aufgerufen werden:

https://example.com/rest/v1/northwinds/mytable(myevent)/{{primaryKeyColumn}}

Wenn wir beispielsweise das obige Beispiel weiter verwenden, würde der folgende Endpoint auf ein „Großbuchstaben“-Ereignis in der Tabelle „Kunden“ abzielen:

customers(uppercase)/{{item/customerId}}

Gehen Sie zum Einrichten wie folgt vor:

• Fügen Sie der App Builder Tabelle ein Großbuchstaben-Ereignis hinzu
• Richten Sie jetzt die REST-konsumierende Seite ein …
• Navigieren Sie zu IDE > Datenserver > Ihr REST-Datenserver > Details

• Klicken Sie im Bereich Endpoint auf + Endpoints und konfigurieren Sie die folgenden Informationen

  • Name: Kunden (Großbuchstaben)
  • Endpoint: customers(uppercase)/{{item/customerId}}
  • Methode: POST

  • Beispiel-Eingabe - App Builder erwartet die Eingabe im folgenden Format:

    {
      "item": {
        "customerId": "abcde"
      }
    }
    

• Klicken Sie auf Speichern

• Klicken Sie auf Entdecken
• Wählen Sie Ihren Kunden (Großbuchstaben)- Endpoint
• Doppelklicken Sie auf die Tabelle Kunden (Großbuchstaben)
• Legen Sie die Spalte customerId als Primärschlüssel fest
• Überprüfen Sie, ob die Richtungen und Speichertypen der Ausgabespalten den Erwartungen entsprechen.

Erstellen einer benutzerdefinierten CRUD-Ereignisregel

Um den benutzerdefinierten Endpoint von Ihrem REST-Objekt aus aufzurufen, müssen Sie eine Regel erstellen, die in den Endpoint eingefügt wird.

• Navigieren Sie zu App Workbench > Datenquellen > Wählen Sie Ihre REST-Datenquelle > Logik
• Wählen Sie den Endpoint (Großbuchstaben) aus
• Klicken Sie im Bereich Regeln auf + Regel und legen Sie Folgendes fest
  • Name: Kunde (Großbuchstaben) Einfügen
  • Zweck: CRUD
  • Aktion: Einfügen
  • Quell-/Zieldatenquelle: Ihre Datenquelle
  • Ziel: Kunden (Großbuchstaben)
• Klicken Sie auf Speichern
• Auf der Tab „Tabellen“:
  • Wählen Sie die Spalte „customerId“ aus und legen Sie die entsprechende item/customerId als Zielspalte fest

Großbuchstabenereignis für REST-Objekt erstellen

Um alles zu verknüpfen, erstellen wir das Großbuchstaben-Ereignis für das REST-Objekt.

• Navigieren Sie zu App Workbench > Datenquellen > REST-Datenquelle auswählen > Logik
• Klicken Sie auf das Symbol Ereignisse für Ihr REST-Objekt.
• Klicken Sie im Fenster „Ereignisse“ auf + Tabellenereignis.
• Setzen Sie den Namen auf Großbuchstaben.
• Klicken Sie auf Speichern.
• Klicken Sie im Fenster „Aktionen“ auf Vorhandene registrieren.
• Wählen Sie die Regel Kunden (Großbuchstaben) einfügen aus.
• Klicken Sie auf Speichern.
• Fügen Sie explizite Bindungen für customerId an customerId ein.
• Gehen Sie zurück zur Seite „Ereignisse“.
• Doppelklicken Sie auf das Großbuchstaben-Ereignis.
• Setzen Sie den Aktualisierungsbereich auf Zeile.

Sie sollten nun bereit sein, das benutzerdefinierte Ereignis aufzurufen. Zum Testen können Sie eine Seite mit einem mehrzeiligen Fenster erstellen, die über eine Schaltfläche zum Aufrufen des Ereignisses verfügt.

Sortieren, Paginieren und Filtern - Verwendungstyp

Die folgenden Abschnitte zu Sortierung, Seitenaufteilung und Filterung beschreiben die Einstellung des Verwendungstyps für bestimmte Parameter. Die angegebenen Beispiele zeigen die Parameternamen, die App Builder verwendet, wenn Sie über eine REST- API Schnittstelle auf App Builder zugreifen. Wenn Sie auf andere externe REST- API Endpoints zugreifen, verfügen diese über eine eigene Liste mit Parameternamen und Werteformaten für Sortierung, Seitenaufteilung und Filterung. Die Informationen in diesen Abschnitten sollen Ihnen helfen, die einzelnen Verwendungstypen zu verstehen und sie unabhängig vom Parameternamen der aufgerufenen REST- API zu verwenden. Die in diesen Abschnitten verwendeten App Builder API Parameter sind in der REST- API ausführlich dokumentiert Artikel.

Sortierung

Der Verwendungstyp, der sich mit der Sortierung befasst, ist Request Sort.

• Request Sort - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API zum Sortieren verwendet. Name und Inhalt dieses Parameters werden vom API Anbieter definiert. Für dieses Beispiel verwenden wir den App Builder API Parameternamen von $sort.

So aktivieren Sie die Sortierung (mit einem App Builder REST-Server):

• Navigieren Sie zu IDE > Datenserver
• Wählen Sie Ihre REST-Datenquelle
• Klicken Sie auf Details
• Klicken Sie unter Webdienstparameter auf + Parameter
• Typ auf Abfrage setzen
• Name auf $sort setzen
• Wert leer lassen
• Setzen Sie den Verwendungstyp auf Anforderungssortierung
• Klicken Sie zum Speichern auf das Häkchen-Symbol

Sie sollten jetzt in der Lage sein, alle Daten zu sortieren, die mit dieser App Builder REST-Datenquelle abgerufen werden.

Seitenaufruf

Die Verwendungstypen, die sich mit der Seitennummerierung befassen, sind Anforderungsanzahl, Anforderungslimit, Anforderungsoffset, Anforderungsseitenzahl und Gesamtzahl der Antwortzeilen.

• Anzahl der Anfragen - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API verwendet, um anzugeben, dass Sie die Gesamtzahl der Zeilen zurückgeben möchten. Einige APIs geben in ihrer Antwort nicht automatisch eine Gesamtzahl zurück und benötigen einen bestimmten Parameter als Auslöser. Für dieses Beispiel verwenden wir den App Builder API Parameternamen von $count.
• Anforderungslimit - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API verwendet, um anzugeben, dass Sie die Gesamtzahl der Zeilen zurückgeben möchten. Einige APIs geben in ihrer Antwort nicht automatisch eine Gesamtzahl zurück und benötigen einen bestimmten Parameter als Auslöser. Für dieses Beispiel verwenden wir den App Builder API Parameternamen von $limit.
• Anforderungsoffset - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API verwendet, um anzugeben, ab welcher Zeile die Daten zurückgegeben werden sollen. Für dieses Beispiel verwenden wir den App Builder API Parameternamen von $offset.
• Seitenzahl anfordern - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API verwendet, um anzugeben, ab welcher Seite die Daten zurückgegeben werden sollen. Einige APIs verwenden die Seitenzahl anstelle des Offsets oder bieten beides an. Sie sollten nur eine Option für Ihren Endpoint definieren, nicht beide. Die App Builder API definiert keinen Parameter für die Seitenzahl.
• Antwort-Gesamtzeilen - Legen Sie diesen Verwendungstyp für den REST-Parameter fest, den die API verwendet, um die Gesamtzahl der Zeilen in der Antwort zurückzugeben. Einige APIs geben in ihrer Antwort nicht automatisch eine Gesamtzahl zurück und benötigen einen bestimmten Parameter als Auslöser. Siehe Verwendungstyp „Anzahl der Anfragen“ oben.

So aktivieren Sie die Seitennummerierung (mit einem App Builder REST-Server):

• Navigieren Sie zu IDE > Datenserver
• Wählen Sie Ihre REST-Datenquelle
• Klicken Sie auf Details
• Klicken Sie unter Webdienstparameter auf + Parameter
  • Typ auf Abfrage setzen
  • Name auf $count setzen
  • Wert auf true setzen
  • Nutzungstyp auf Anzahl der Anfragen setzen
  • Klicken Sie zum Speichern auf das Häkchen-Symbol
• Klicken Sie unter Webdienstparameter auf + Parameter
  • Typ auf Abfrage setzen
  • Name auf $limit setzen
  • Wert leer lassen
  • Nutzungstyp auf Anforderungslimit setzen
  • Klicken Sie zum Speichern auf das Häkchen-Symbol
• Klicken Sie unter Webdienstparameter auf + Parameter
  • Typ auf Abfrage setzen
  • Name auf $offset setzen
  • Wert leer lassen
  • Nutzungstyp auf Anforderungsoffset setzen
  • Klicken Sie zum Speichern auf das Häkchen-Symbol
• Navigieren Sie für alle Endpoints, die Paging unterstützen, zur Endpoint, die den Parameter „count“ enthält.
  • In unserem obigen Beispiel wäre dies die Tabelle „customers (get)“
  • Legen Sie den Verwendungstyp der Zählspalte auf Antwort-Gesamtzeilen fest.

Die Schaltfläche „Weitere Zeilen laden“ sollte jetzt für alle von diesem Endpoint abgerufenen Daten funktionieren.

Optionen für die Panelanzeige

Wenn Sie ein Panel zur Anzeige von REST-Objektdaten konfigurieren, stehen in Edge Case Optionen zur Verfügung, mit denen Sie die Anzeige der Datensätze im Panel steuern können. Sie können steuern, ob App Builder eine festgelegte Anzahl von Datensätzen zusammen mit der Schaltfläche „Weitere Zeilen laden“ lädt oder ob eine festgelegte Anzahl von Datensätzen zusammen mit Seitennavigationssteuerelementen im Symbolleistenbereich angezeigt wird, um weitere Datensätze zu laden.

Darüber hinaus können Sie, sofern die REST- API Konfiguration dies unterstützt, die Anzahl der Datensätze festlegen, die App Builder zunächst im Bedienfeld anzeigt.

So laden Sie weitere Zeilen

• Navigieren Sie zum Panel mit dem REST-Objekt als Quelle.
• Gehen Sie zu Diese Seite gestalten.
• Gehen Sie zu Mehr > Sonderfall für das Panel.
• Stellen Sie die Paging-Option auf Weitere Zeilen laden.

So aktivieren Sie die Paging-Funktion

• Navigieren Sie zum Panel mit dem REST-Objekt als Quelle.
• Gehen Sie zu Diese Seite gestalten.
• Gehen Sie zu Mehr > Sonderfall für das Panel.
• Setzen Sie die Seitenoptionen auf Seitenverwaltung.

So legen Sie die Anzahl der anfänglich geladenen Datensätze fest

• Navigieren Sie zum Panel mit dem REST-Objekt als Quelle.
• Gehen Sie zu Diese Seite gestalten.
• Gehen Sie zu Mehr > Sonderfall für das Panel.
• Setzen Sie Zeilen pro Anfrage auf den numerischen Wert, den Sie initial laden möchten.

Filtern

Die Verwendungsarten für die Filterung sind Request Filter und Request Filter (OData). Legen Sie diese Verwendungsart für den REST-Parameter fest, den die API zum Filtern verwendet. Request Filter dient zur einfachen Filterung, Request Filter (OData) hingegen zum Filtern nach dem OData Standard. Dieser Standard definiert verschiedene Filterbedingungen. Die App Builder API verwendet den OData-Style-Filter, wie in unserem Beispiel. Prüfen Sie vor der Verwendung in Ihrer API Dokumentation, ob die OData Filterung unterstützt wird. Weitere Informationen zur OData Filterung finden Sie hier in diesen REST- API Empfehlungen Artikel.

So aktivieren Sie die Filterung (mit einem App Builder REST-Server):

• Navigieren Sie zu IDE > Datenserver
• Wählen Sie Ihre REST-Datenquelle
• Klicken Sie auf Details
• Klicken Sie unter Webdienstparameter auf + Parameter
  • Typ auf Abfrage setzen
  • Name auf $filter setzen
  • Wert leer lassen
  • Verwendungstyp auf Anforderungsfilter (OData) setzen
  • Klicken Sie zum Speichern auf das Häkchen-Symbol

Sie sollten jetzt in der Lage sein, alle Daten zu filtern, die mit dieser App Builder REST-Datenquelle abgerufen werden.

Das Filtern über einen REST-Dienst unterstützt Folgendes:

Operatoren

• eq - Gleich
• neq- Ungleich
• gt- Größer als
• ge- Größer als oder gleich
• lt- Weniger als
• le - Kleiner als oder gleich

Einschränkungen

• Keine Rechenoperatoren
• Keine logischen Oder/Nicht-Operatoren
• Keine Gruppierungsoperatoren
• Abfrage Abfragefunktionen
• Keine Parameter-Aliase