API -Antwortaktivität

Einführung

Eine API -Antwort-Aktivität unter Verwendung ihrer vorkonfigurierten API Verbindung, gibt Daten an eine benutzerdefinierte API-Manager API zurück und soll als Ziel zum Verbrauchen von Daten in einer Operation verwendet werden.

Die API -Antwort-Aktivität kann mithilfe eines JSON-, XML-, CSV- oder XSD Schema konfiguriert werden. Um mit einer API -Verbindung über ein WSDL Schema zu interagieren, verwenden Sie eine API SOAP Antwort-Aktivität stattdessen.

Informationen zur Beziehung zwischen API Connector-Aktivitäten und API-Manager APIs finden Sie in diesen Ressourcen:

Erstellen einer API Antwortaktivität

Eine Instanz einer API Response-Aktivität wird aus der vorkonfigurierten API Verbindung erstellt mithilfe des Aktivitätstyps Antwort.

Um eine Instanz einer Aktivität zu erstellen, ziehen Sie den Aktivitätstyp auf die Design-Canvas oder kopieren Sie den Aktivitätstyp und fügen Sie ihn auf der Design-Canvas ein. Weitere Informationen finden Sie unter Erstellen Sie eine Aktivität oder Tool-Instanz in Komponentenwiederverwendung.

Eine vorhandene API -Antwort-Aktivität kann von diesen Orten aus bearbeitet werden:

Die Design-Canvas (siehe Aktionsmenü in Entwurfsfläche).
Die Tab Komponenten des Projektbereichs (siehe Aktionsmenü im Projektbereich Tab Komponenten).

Konfigurieren einer API Antwortaktivität

Befolgen Sie diese Schritte, um eine API -Antwort-Aktivität zu konfigurieren:

Schritt 1: Geben Sie einen Namen ein und legen Sie eine bevorzugte Schema fest
Geben Sie einen Namen für die Aktivität ein und wählen Sie eine bevorzugte Schema aus.
Schritt 2: Überprüfen Sie die Datenschemata
Alle vom Endpoint generierten Anforderungs- oder Antwortschemata werden angezeigt.

Schritt 1: Geben Sie einen Namen ein und legen Sie eine Schema fest

Geben Sie in diesem Schritt einen Namen für die Aktivität an und wählen Sie eine Schema aus. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

API -Antwortaktivitätskonfigurationsschritt 1

Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede API -Antwort-Aktivität eindeutig sein und darf keine Schrägstriche enthalten. /oder Doppelpunkte :.
Schema bereitstellen: Das Schema definiert die Struktur der Daten, die von der API -Antwort-Aktivität verwendet werden. Ob ein Schema erforderlich ist, hängt davon ab, ob die API -Antwort-Aktivität als Ziel einer Transformation verwendet wird. Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter Schemaverwendung und In einer Aktivität definierte Schemata.
Speichern und beenden: Wenn aktiviert, klicken Sie hier, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.
Weiter: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und mit dem nächsten Schritt fortzufahren. Die Konfiguration wird erst gespeichert, wenn Sie im letzten Schritt auf die Schaltfläche Fertig klicken.
Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. Sie werden in einer Meldung aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 2: Überprüfen der Datenschemata

Alle vom Endpoint generierten Anforderungs- oder Antwortschemata werden angezeigt. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

API -Antwortaktivitätskonfigurationsschritt 2

Datenschemata: Die Anforderungs- und Antwortschemata für diese Aktivität werden angezeigt. Diese Datenschemata werden von benachbarten Transformations übernommen und während der Transformation erneut angezeigt..

Notiz

Die in einer Transformation bereitgestellten Daten haben Vorrang vor der Aktivitätskonfiguration.
Plugin(s) hinzufügen: Plugins sind von Jitterbit oder vom Benutzer bereitgestellte Anwendungen, die die nativen Funktionen von Harmony erweitern. Um ein Plugin auf die Aktivität anzuwenden, klicken Sie, um diesen Abschnitt zu erweitern, und aktivieren Sie das Kontrollkästchen neben dem zu verwendenden Plugin. Weitere Anweisungen zur Verwendung von Plugins, einschließlich Details zum Festlegen aller erforderlichen Variablen, die vom Plugin verwendet werden, finden Sie unter Zu einer Aktivität hinzugefügte Plugins.
Zurück: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.
Fertig: Klicken Sie hier, um die Konfiguration für alle Schritte zu speichern und die Aktivitätskonfiguration zu schließen.
Änderungen verwerfen: Klicken Sie nach dem Vornehmen von Änderungen hier, um die Konfiguration zu schließen, ohne die an einem Schritt vorgenommenen Änderungen zu speichern. In einer Meldung werden Sie aufgefordert, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Nächste Schritte

Nachdem Sie eine API Response-Aktivität konfiguriert haben, schließen Sie die Konfiguration der Operation ab, indem Sie weitere Aktivitäten oder Tools hinzufügen und konfigurieren als Operation. Sie können auch die Operation konfigurieren, die die Möglichkeit umfassen, Operationen zu verketten, die sich im gleichen oder in unterschiedlichen Workflows befinden.

Sobald eine API Antwort-Aktivität erstellt wurde, sind Menüaktionen für diese Aktivität über den Projektbereich entweder auf den Registerkarten Workflows oder Komponenten und über die Design-Canvas zugänglich. Siehe Aktionsmenü für weitere Einzelheiten.

API Response-Aktivitäten können als Ziel mit diesen Operation verwendet werden:

Archivmuster
Script
Transformation
Zwei-Ziel-Archivmuster (nur als zweites Ziel)
HTTP-Archivmuster mit zwei Zielen (nur als zweites Ziel)
Zwei-Transformationsmuster (nur als zweites Ziel)

Wichtig

Standardmäßig werden erfolgreiche Vorgänge, die für eine benutzerdefinierte API konfiguriert sind, sind nicht in den Operation enthalten, sofern nicht eine dieser Einstellungen aktiviert ist:

Cloud-Agenten: Für API Operationen auf einem Cloud-Agenten Operation debuggen muss für die Operation aktiviert sein.
Private Agenten: Für API Operationen auf einem privaten Agenten muss entweder Operation debuggen muss für die Operation aktiviert sein oder Sie müssen EnableLogging=true im [APIoperation] Abschnitt der privaten Agentenkonfigurationsdatei.

Nicht erfolgreiche Vorgänge werden in die Operation aufgenommen, ob die oben genannten Einstellungen aktiviert sind oder nicht.

Konfigurieren einer benutzerdefinierten API-Manager API

Sobald der Operation konfiguriert und bereitgestellt ist, konfigurieren Sie eine benutzerdefinierte API mit API-Manager.

Notiz

Nachdem Sie eine benutzerdefinierte API zum Aufrufen konfiguriert haben an Integration Studio Operation, können Sie die Operation nicht löschen, ohne entweder die API zu löschen oder die Konfiguration der API so zu ändern, dass die Operation nicht mehr aufgerufen wird.