Zum Inhalt springen

HTTP v2 GET-Aktivität

Einführung

Eine HTTP v2 GET-Aktivität unter Verwendung ihrer HTTP v2-Verbindung, ruft Informationen zu einer Ressource eines Dienstes ab, auf den über das HTTP- oder HTTPS-Protokoll zugegriffen werden kann, und kann entweder als Quelle (zum Bereitstellen von Daten in einem Operation) oder als Ziel (zum Verwenden von Daten in einem Operation) verwendet werden.

Erstellen einer HTTP v2 GET-Aktivität

Eine Instanz einer HTTP v2 GET-Aktivität wird aus einer HTTP v2-Verbindung erstellt mithilfe des Aktivitätstyps GET.

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 einer Aktivitätsinstanz in Komponentenwiederverwendung.

Eine vorhandene HTTP v2 GET-Aktivität kann an diesen Stellen bearbeitet werden:

Konfigurieren einer HTTP v2 GET-Aktivität

Befolgen Sie diese Schritte, um eine HTTP v2 GET-Aktivität zu konfigurieren:

Schritt 1: Namen eingeben und Einstellungen festlegen

Geben Sie in diesem Schritt einen Namen für die Aktivität an und geben Sie die URL, Anforderungsparameter, Anforderungsheader und zusätzliche Einstellungen an. Jedes Benutzeroberflächenelement dieses Schritts wird unten beschrieben.

HTTP v2 GET-Aktivitätskonfiguration Schritt 1

Tipp

Felder mit variablem Symbol Unterstützung der Verwendung von globalen Variablen, Projektvariablen und Jitterbit-Variablen. Beginnen Sie entweder mit einer öffnenden eckigen Klammer [ in das Feld oder durch Klicken auf das Variablensymbol, um eine Liste der vorhandenen Variablen anzuzeigen, aus denen Sie auswählen können.

Wichtig

Felder in den Tabellen zeigen das variable Symbol nur im Bearbeitungsmodus. Damit die Variablenwerte dieser Felder zur Laufzeit ausgefüllt werden, muss die Agentenversion mindestens 10.75 / 11.13 sein.

  • Name: Geben Sie einen Namen zur Identifizierung der Aktivität ein. Der Name muss für jede HTTP v2 GET-Aktivität eindeutig sein und darf keine Schrägstriche enthalten / oder Doppelpunkte :.

  • Pfad: Geben Sie eine für die Aktivität zu verwendende URL ein:

    • Wenn leer gelassen, die Basis URL, die in der HTTP v2-Verbindung konfiguriert ist wird zur Laufzeit verwendet.
    • Wenn ein Teilpfad angegeben wird, wird er an die Basis URL angehängt, die in der HTTP v2-Verbindung konfiguriert ist.
    • Wenn eine vollständige URL angegeben wird, überschreibt diese die in der HTTP v2-Verbindung konfigurierte Basis URL.

    Anforderungsparameter können eingefügt werden, indem sie in geschweifte Klammern eingeschlossen werden { }. Abfrageparameter (wie /queryrecord?id=10) kann ebenfalls verwendet werden.

    • URL: Zeigt die vollständige URL an, die zur Laufzeit verwendet werden soll.

  • Anforderungsparameter: Klicken Sie auf das Symbol „Hinzufügen“ , um der Tabelle unten eine Zeile hinzuzufügen, und geben Sie für jeden Anforderungsparameter einen Namen und einen Wert ein. Die angegebenen Anforderungsparameter werden automatisch URL-codiert.

    Alternativ können Anforderungsparameter in der Transformation angegeben werden. Anforderungsparameter, die keinen gemeinsamen Schlüssel haben, werden kumulativ gesendet, unabhängig davon, wo sie angegeben werden. Wenn sowohl in diesem Feld als auch in der Transformation derselbe Parameterschlüssel angegeben wird, hat der in der Transformation angegebene Schlüssel Vorrang.

    Um die Zeile zu speichern, klicken Sie auf das Senden-Symbol in der Spalte ganz rechts.

    Um eine einzelne Zeile zu bearbeiten oder zu löschen, bewegen Sie den Mauszeiger über die Spalte ganz rechts und verwenden Sie das Bearbeitungssymbol oder Symbol „Löschen“ .

    Um alle Zeilen zu löschen, klicken Sie auf Alle löschen.

  • Anforderungsheader: Klicken Sie auf das Symbol „Hinzufügen“ , um der Tabelle unten eine Zeile hinzuzufügen und für jeden Header einen Namen und einen Wert einzugeben.

    Alternativ können Header in anderen UI-Konfigurationsfeldern definiert oder in der Transformation bereitgestellt werden. Header, die keinen gemeinsamen Schlüssel haben, werden kumulativ gesendet, unabhängig davon, wo sie angegeben sind.

    Wenn der gleiche Header Schlüssel an mehreren Stellen angegeben wird, gilt diese Rangfolge:

    1. Ein in der Transformation bereitgestellter Header überschreibt alle darunter liegenden Felder.
    2. Ein Header im Feld Anforderungsheader einer HTTP v2 GET-Aktivität (dieses Feld) überschreibt das verbleibende Feld unten.
    3. Ein Header, der im Feld Request Headers einer HTTP v2-Verbindung bereitgestellt wird, wenn Senden von Anforderungsheadern bei Aktivitätsausführung aktiviert ist, hat die geringste Priorität.

    Notiz

    Wenn ein Header an mehreren Stellen definiert ist, wird jede Instanz des Header der Anforderung einer Aktivität gemäß der oben genannten Rangfolge hinzugefügt. Diese Reihenfolge basiert darauf, wie Dienste normalerweise doppelte Header in einer Anforderung verarbeiten.

    Um die Zeile zu speichern, klicken Sie auf das Senden-Symbol in der Spalte ganz rechts.

    Um eine einzelne Zeile zu bearbeiten oder zu löschen, bewegen Sie den Mauszeiger über die Spalte ganz rechts und verwenden Sie das Bearbeitungssymbol oder Symbol „Löschen“ .

    Um alle Zeilen zu löschen, klicken Sie auf Alle löschen.

  • Zusätzliche Einstellungen: Klicken Sie auf das Symbol „Hinzufügen“ um der Tabelle unten eine Zeile hinzuzufügen und für jede zusätzliche Einstellung einen Namen und Wert einzugeben.

    Diese zusätzlichen Einstellungen werden unterstützt:

    Schlüssel
    		 Standardwert Datentyp Beschreibung
    connection-timeout 30000 Integer Das Übertragungstimeout in Millisekunden. Wenn diese Einstellung nicht angegeben ist, beträgt das Standardübertragungstimeout 30000 Millisekunden (30 Sekunden). Eingestellt auf 0 für eine unbegrenzte Zeitüberschreitung.
    content-type — String Der Inhaltstyp der Anforderungsstruktur, der von der jeweiligen API erwartet wird. Beispiel: text/plain, application/json, application/x-www-form-urlencoded, usw. Wenn diese Einstellung nicht angegeben ist, gibt es keinen Standardwert.
    max-redirect 50 Integer Die maximale Anzahl der zu befolgenden Weiterleitungen. Wenn diese Einstellung nicht angegeben ist, wird standardmäßig 50 Weiterleitungen. Eingestellt auf 0 oder eine negative Zahl, um das Folgen von Weiterleitungen zu verhindern.
    trailing-linebreaks false String Entfernt führende und nachfolgende Leerzeichen und Zeilenumbrüche, wenn eingestellt auf true Wenn diese Einstellung nicht angegeben oder auf false, die Daten bleiben unverändert.

    Alternativ können zusätzliche Einstellungen in der Transformation bereitgestellt werden. Zusätzliche Einstellungen, die keinen gemeinsamen Schlüssel haben, werden kumulativ gesendet, unabhängig davon, wo sie angegeben werden. Für alle Einstellungen außer dem Inhaltstyp gilt: Wenn sowohl in diesem Feld als auch in der Transformation der gleiche Einstellungsschlüssel angegeben wird, hat der in der Transformation angegebene Schlüssel Vorrang.

    Für content-type, ein hier angegebener Wert hat Vorrang vor allen anderen Stellen in der Benutzeroberfläche, an denen der Inhaltstyp angegeben werden kann. Wenn der Inhaltstyp an mehreren Stellen angegeben wird, gilt diese Rangfolge:

    1. A Content-Type Der in der Tabelle Zusätzliche Einstellungen einer HTTP v2 GET-Aktivität (diese Tabelle) bereitgestellte Header überschreibt alle folgenden Felder.
    2. Die bodyContentType Das in einer Transformation angegebene Feld überschreibt die verbleibenden Felder unten.
    3. EIN Content-Type Header, der in der Transformation bereitgestellt wird headers Knoten überschreibt die verbleibenden Felder unten.
    4. Ein Content-Type Der im Feld Anforderungsheader einer HTTP v2 GET-Aktivität angegebene Header überschreibt das verbleibende Feld unten.
    5. EIN Content-Type Der im Feld Anforderungsheader einer HTTP v2-Verbindung angegebene Header hat die niedrigste Priorität, wenn Anforderungsheader in Aktivitätsausführung senden aktiviert ist.

    Notiz

    Wenn ein Header an mehreren Stellen definiert ist, wird jede Instanz des Header der Anforderung einer Aktivität gemäß der oben genannten Rangfolge hinzugefügt. Diese Reihenfolge basiert darauf, wie Dienste normalerweise doppelte Header in einer Anforderung verarbeiten.

    Um die Zeile zu speichern, klicken Sie auf das Senden-Symbol in der Spalte ganz rechts.

    Um eine einzelne Zeile zu bearbeiten oder zu löschen, bewegen Sie den Mauszeiger über die Spalte ganz rechts und verwenden Sie das Bearbeitungssymbol oder Symbol „Löschen“ .

    Um alle Zeilen zu löschen, klicken Sie auf Alles löschen.

  • Optionale Einstellungen: Klicken Sie hier, um weitere optionale Einstellungen einzublenden:

    • Operation bei nicht erfolgreichem Statuscode ignorieren: Wählen Sie diese Option aus, damit Operationen einen erfolgreichen Status melden, auch wenn von der API, die der Connector aufruft, ein nicht erfolgreicher Statuscode zurückgegeben wird. Der Standardwert ist nicht ausgewählt.

    • Wählen Sie den HTTP-Statuscode aus, der zur Laufzeit des Operation als erfolgreich gewertet werden soll: Wählen Sie entweder Nach Klasse gruppiert oder Granular (Manuelle Eingabe) aus, um die angegebenen Statuscodes in Operation als erfolgreich zu werten.

      • Gruppiert nach Klasse: Wenn ausgewählt, wird ein Dropdown-Menü mit Klassen nicht erfolgreicher Statuscodes angezeigt, die als erfolgreich behandelt werden sollen. Zu den Dropdown-Optionen gehören 3xx Umleitung, 4xx Client-Fehler und 5xx Server-Fehler. Der Standardwert des Dropdown-Menüs ist nicht ausgewählt.

      • Granular (manuelle Eingabe): Wenn ausgewählt, wird ein Feld angezeigt, in das Sie manuell eine durch Kommas getrennte Liste nicht erfolgreicher Statuscodes eingeben können, die als erfolgreich behandelt werden sollen. Diese Liste kann gleichzeitig verschiedene Klassen von Statuscodes enthalten. Der Standardwert des Felds ist leer.

        Granulärer Status von HTTP v2

  • Speichern und beenden: Klicken Sie, wenn aktiviert, um die Konfiguration für diesen Schritt zu speichern und die Aktivitätskonfiguration zu schließen.

  • Weiter: Klicken Sie, 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, 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: Angeben des Schema

In diesem Schritt können Sie ein benutzerdefiniertes Schema angeben. Wenn Sie kein benutzerdefiniertes Schema angeben, wird das Schema des Connectors verwendet.

HTTP v2 GET-Aktivitätskonfiguration Schritt 2

  • Anforderungsschema angeben: Das Schema definiert die Struktur der Anforderungsdaten, die von der HTTP v2 GET-Aktivität verwendet werden. Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter In einer Aktivität definierte Schemata.

  • Zurück: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • 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. In einer Meldung werden Sie aufgefordert zu bestätigen, dass Sie die Änderungen verwerfen möchten.

Schritt 3: Angeben des Schema

In diesem Schritt können Sie ein benutzerdefiniertes Schema angeben. Wenn Sie kein benutzerdefiniertes Schema angeben, wird das Schema des Connectors verwendet.

HTTP v2 GET-Aktivitätskonfiguration, Schritt 3

  • Antwortschema bereitstellen: Das Schema definiert die Struktur der Antwortdaten, die von der HTTP v2 GET-Aktivität verwendet werden. Anweisungen zum Ausfüllen dieses Abschnitts der Aktivitätskonfiguration finden Sie unter In einer Aktivität definierte Schemata.

  • Zusätzliche Eigenschaften aus HTTP-Antwort in das Schema einschließen: Wenn Ja, gespeichertes Schema verwenden oder Ja, neues Schema bereitstellen ausgewählt ist und das verwendete Schema einen XML- oder JSON-Dateityp hat, wird das Kontrollkästchen Zusätzliche Eigenschaften aus HTTP-Antwort in das Schema einschließen angezeigt. Wenn diese Option ausgewählt ist, wird das Schema in eine Jitterbit-definierte Struktur eingeschlossen, sodass zusätzliche Parameter im Schema zugänglich sind:

    Zusätzliche HTTP v2-Eigenschaften im Schema

    {
  "__jitterbit_aditional_properties__": {
    "__jitterbit_api_headers__": [
      {
        "key": "",
        "value": ""
      },
      {
        "key": "",
        "value": ""
      }
    ],
    "__jitterbit_api_statuscode__": 200,
    "__jitterbit_api_errorbody__": ""
  },
  "root": {
    // Original JSON
  }
}

    <__jitterbitResponse__>
    <__jitterbit_aditional_properties__>
        <__jitterbit_api_headers__>
            <key>headerKey1</key>
            <value>headerValue1</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_headers__>
            <key>headerKey2</key>
            <value>headerValue2</value>
        </__jitterbit_api_headers__>
        <__jitterbit_api_statuscode__>200</__jitterbit_api_statuscode__>
        <__jitterbit_api_errorbody__>
        </__jitterbit_api_errorbody__>
    </__jitterbit_aditional_properties__>
    <root>
        <!-- Original XML -->
    </root>
</__jitterbitResponse__>

    • __jitterbit_api_headers__: Gibt die vom Anforderungsaufruf bereitgestellten Header zurück.

    • __jitterbit_api_statuscode__: Gibt den Statuscode des Anforderungsaufrufs zurück.

    • __jitterbit_api_errorbody__: Gibt den Antworttext des Anforderungsaufrufs im Zeichenfolgenformat zurück, wenn der Anforderungsaufruf einen erfolglosen Statuscode zurückgibt.

    • root: Enthält die ursprüngliche Struktur des Schema.

    Notiz

    Wenn diese Option ausgewählt ist, wird ein neues Schema mit dem Wrapper generiert. Die Struktur des ursprünglichen Schema bleibt erhalten root Da hierfür ein neues Schema generiert wird, kann bei Bedarf später wieder auf das Original ohne Wrapper zurückgegriffen werden.

  • Zurück: Klicken Sie hier, um die Konfiguration für diesen Schritt vorübergehend zu speichern und zum vorherigen Schritt zurückzukehren.

  • 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 hierauf, 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 4: Überprüfen der Datenschemata

Die konfigurierten Anfrage- und Antwortschemata werden angezeigt.

HTTP v2 GET-Aktivitätskonfiguration Schritt 4

  • Datenschemata: Diese Datenschemata werden von benachbarten Transformations übernommen und beim Transformation erneut angezeigt.

    Wenn in den vorherigen Schritten benutzerdefinierte Schemata bereitgestellt wurden, werden diese angezeigt. Wenn keine benutzerdefinierten Schemata bereitgestellt wurden, werden die im Connector enthaltenen Standardschemata angezeigt.

    Für HTTP v2-Aktivitäten werden Datenschemata automatisch basierend auf Aktualisierungen der in den vorherigen Schritten definierten Schemata neu generiert.

    Vorsicht

    Bei HTTP v2-Aktivitäten, die vor der Harmony Version 10.85/11.23 erstellt wurden, ist aufgrund zuvor definierter Projektmetadaten möglicherweise eine manuelle Schaltfläche Aktualisieren vorhanden. Falls vorhanden, interagieren Sie nicht mit dieser Schaltfläche. Erstellen Sie eine neue Instanz einer betroffenen Aktivität, um sie zu entfernen.

    Die Standardanforderungs- und -antwortschemata bestehen aus diesen Knoten und Feldern:

    • Anfrage:

      Schemaknoten/-feld anfordern Hinweise
      json Format des Schema
      Anfrage Anfrageknoten
      root Stammknoten
      Header Knoten mit Headern
      Element Knoten einer bestimmten Header
      Schlüssel Schlüssel der Header
      Wert Wert des Header
      requestParameters Knoten der Anforderungsparameter
      item Knoten eines bestimmten Anfrageparameters
      Schlüssel Schlüssel des Anfrageparameters
      Wert Wert des Anfrageparameters
      additionalSettings Knoten mit zusätzlichen Einstellungen
      item Knoten einer bestimmten zusätzlichen Einstellung
      Schlüssel Schlüssel der Zusatzeinstellung
      Wert Wert der zusätzlichen Einstellung
      Text Anforderungstext
      Inhaltstyp Content-Type des Anforderungstexts

      Hinweis

      Dieses Feld hat Vorrang vor einem Content-Type Header im headers Knoten.

    • Antwort:

      Antwortschemaknoten/-feld Hinweise
      json Format des Schema
      Antwort Antwortknoten
      responseItem Knoten des Antwortelements
      Status Ein Boolescher Wert, der angibt, ob eine Antwort zurückgegeben wurde
      Eigenschaften Eigenschaften der Antwort
      Header Knoten mit Headern
      Element Knoten einer bestimmten Header
      Schlüssel Schlüssel der Header
      Wert Wert des Header
      responseContent Inhalt der Antwort
      Fehler Fehlerknoten
      statusCode HTTP-Statuscode der Antwort
      statusMessage Statusmeldung der Antwort
      Details Antwortdetails

  • 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 HTTP v2 GET-Aktivität konfiguriert haben, schließen Sie die Konfiguration des Operation ab, indem Sie andere Aktivitäten, Transformations oder Scripts als Operation hinzufügen und konfigurieren. Sie können auch die Operation konfigurieren, die die Möglichkeit umfassen, Vorgänge zu verketten, die sich im selben oder in unterschiedlichen Workflows befinden.

Auf Menüaktionen für eine Aktivität kann über den Projektbereich und die Design-Canvas zugegriffen werden. Weitere Informationen finden Sie unter Aktionsmenü in Connector-Grundlagen.

HTTP v2 GET-Aktivitäten, die als Quelle verwendet werden, können mit diesen Operation verwendet werden:

HTTP v2 GET-Aktivitäten, die als Ziel verwendet werden, können mit diesen Operation verwendet werden:

Um die Aktivität mit Skriptfunktionen zu verwenden, schreiben Sie die Daten an einen temporären Speicherort und verwenden Sie dann diesen temporären Speicherort in der Skriptfunktion.

Wenn Sie bereit sind, einsetzen und ausführen den Operation und validieren Sie das Verhalten durch Überprüfen der Operation.