Anforderungsbody angeben

Geben Sie den Anforderungsbody an, der für eine REST-Anforderung mit der POST- oder PUT-Methode erforderlich ist.

Mit den folgenden Prozeduren können Sie einen Anforderungstext in der HTTP-Haupt-URL oder der optionalen Polling-URL und Beendigungs-URL konfigurieren.

Anforderungsbody hinzufügen

Derzeit wird nur JSON als Format für einen Anforderungsbody unterstützt.

So erstellen Sie einen Anforderungsbody:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren im Schritt Ausführungsdetails definieren die Option Anforderung aus, um einen Anforderungsbody für die REST-Aufgabe zu erstellen.

    Um einen Anforderungsbody für eine Polling- oder Beendigungs-URL zu erstellen, gehen Sie zur Seite Abschlusskriterien angeben, und aktivieren Sie das Kontrollkästchen Polling- und Beendigungsbedingung für einen REST-Aufruf ohne Wartezeit konfigurieren. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Anforderung aus.

    Wenn die Registerkarte "Anforderung" nicht angezeigt wird, stellen Sie sicher, dass Sie die richtige HTTP-Methode ausgewählt haben.

  2. Geben Sie den Anforderungsbody im Editor ein.
    • Sie können die gesamte Payload eingeben oder kopieren und einfügen.

    • Sie können vorhandene Parameter in der Payload mit der Syntax ${} referenzieren. Beispiel:

      {
          "modelType": "USER_PROJECT",
          "modelVersion": "20200901",
          "parentRef": {},
          "name": "${PROJECT_NAME}",
          "identifier": "${PROJECT_NAME}",
          "description": "Creating my project",
          "objectVersion": 0,
          "objectStatus": 8,
          "registryMetadata": {
              "registryVersion": 0
          }
      }
    Hinweis

    Der integrierte Validator im Editor validiert den Anforderungsbody. Wenn ein roter Punkt mit einem "x" auf der Seite des Editors angezeigt wird, bewegen Sie den Mauszeiger auf das Symbol, um den Fehler für diese Codezeile anzuzeigen.
  3. Um einen Aufgabenparameter für den gesamten Anforderungsbody zuzuweisen, wählen Sie Als Aufgabenparameter verfügbar gemacht aus. Siehe Anforderungsbody parametrisieren.

    Um den Body eines parametrisierten Anforderungstextes zu bearbeiten, bearbeiten Sie den Wert des Parameters.

Anforderungsbody parametrisieren

Sie können nicht nur Parameter im Anforderungsbody verwenden, sondern auch den gesamten Anforderungsbody parametrisieren.

Siehe Anforderungsbody hinzufügen.

Nachdem Sie den Anforderungsbody im Editor erstellt haben, können Sie dem gesamten Body einen Aufgabenparameter zuweisen.

So parametrisieren Sie den gesamten Anforderungsbody:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren im Schritt Ausführungsdetails definieren die Option Anforderung aus.

    Um den Anforderungsbody für eine Polling- oder Beendigungs-URL zu parametrisieren, gehen Sie zur Seite Abschlusskriterien angeben. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Anforderung aus.

  2. Wählen Sie Als Aufgabenparameter verfügbar aus.

    Wenn Sie den Anforderungsbody noch nicht eingegeben haben, zeigt Data Integration ein Dialogfeld mit einer Warnung an. Geben Sie zuerst einen Anforderungsbody ein, und weisen Sie dann dem gesamten Body einen Parameter zu.

  3. Geben Sie im Bereich Parameter hinzufügen einen Namen für den Parameter ein, oder verwenden Sie den Standardwert.

    Der Parametername muss in der REST-Aufgabe eindeutig sein. Eine aktuelle Liste der Parameter in der Aufgabe finden Sie mit den Schritten unter Alle Parameter in einer REST-Aufgabe anzeigen.

  4. (Optional) Geben Sie eine Beschreibung ein, damit andere Benutzer den Zweck des Parameters erkennen können.
  5. Der Datentyp des Parameters ist JSON. Diesen können Sie nicht ändern.
  6. Geben Sie im Feld Wert die Standard-JSON für diesen Aufgabenparameter an.
  7. Wählen Sie Hinzufügen aus.
    Der Parametername wird oben im Editor hinzugefügt.

Um den Body eines parametrisierten Anforderungstextes zu bearbeiten, bearbeiten Sie den Wert des Parameters.

Wert eines Anforderungsbodyparameters bearbeiten

Sie können den Standardwert des Task-Parameters für den Request-Body ändern.

So bearbeiten Sie den parametrisierten Anforderungsbody:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren einer POST- oder PUT-Methode im Schritt Ausführungsdetails definieren die Option Anforderung aus.

    Um den parametrisierten Anforderungsbody für eine Polling- oder Beendigungs-URL zu bearbeiten, gehen Sie zur Seite Abschlusskriterien angeben. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Anforderung aus.

  2. Wählen Sie Parameter bearbeiten aus.
  3. Im Bereich "Parameter bearbeiten" können Sie nur das Feld Wert bearbeiten. Den Datentyp oder die Beschreibung können Sie nicht ändern.

    Informationen zum Bearbeiten der Beschreibung finden Sie unter REST-Aufgabenparameter bearbeiten.

  4. Wählen Sie Speichern aus.
Anforderungsbodyparameter entfernen

Wenn Sie den Parameter entfernen, wird nur die Verknüpfung des Parameters mit dem Anforderungsbody in der REST-Aufgabe entfernt.

So heben Sie die Zuweisung des Parameters zum gesamten Anforderungsbody auf:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren einer POST- oder PUT-Methode im Schritt Ausführungsdetails definieren die Option Anforderung aus.

    Um die Zuweisung des Parameters zum Anforderungsbody für eine Polling- oder Beendigungs-URL aufzuheben, gehen Sie zur Seite Abschlusskriterien angeben. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Anforderung aus.

  2. Wählen Sie Parameter entfernen aus.
  3. Wählen Sie im Dialogfeld "Parameter entfernen" die Option Entfernen aus.

    Die Zuweisung des Parameters zum Anforderungsbody wird aufgehoben. Der Anforderungstext, der dem Parameter zugewiesen wurde, wird zum Standardanforderungstext.

    Hinweis

    Der Parameter wird nicht aus der REST-Aufgabe gelöscht. Informationen zum Löschen des Parameters finden Sie unter REST-Aufgabenparameter löschen.