Header hinzufügen und verwalten

Definieren Sie mindestens einen Header, der an den Headerabschnitt der REST-Anforderung übergeben werden soll. Ein Header verfügt über einen Schlüssel und einen Wert. Alle standardmäßigen REST-API-Anforderungsheader werden unterstützt.

Beispiel: Sie können den Content-Type-Header für eine POST- oder PUT-Anforderung hinzufügen.

Die folgenden Prozeduren können verwendet werden, um Header in der HTTP-Haupt-URL oder der optionalen Polling-URL und Beendigungs-URL hinzuzufügen und zu verwalten.

Header erstellen

Erstellen Sie einen Anforderungsheader für die HTTP-Hauptmethode oder die optionalen Polling- und Beendigungs-HTTP-Methoden.

So erstellen Sie einen Header:

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

    Um einen Header für die 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 Header aus.

  2. Wählen Sie Header hinzufügen aus.
  3. Geben Sie im Feld Schlüssel den Namen eines Titels ein.
    Wird ein übereinstimmender Schlüssel gefunden, wird eine Liste mit Vorschlägen in einem Menü angezeigt. Wählen Sie den gewünschten Header aus.
  4. Geben Sie im Feld Wert den Namen des Headerwerts ein.
    Wird ein übereinstimmender Wert gefunden, wird eine Liste mit Vorschlägen in einem Menü angezeigt. Wählen Sie den gewünschten Headerwert aus.
  5. Wählen Sie Hinzufügen aus.

    Headerschlüssel und -wert werden der Tabelle Header hinzugefügt.

    Um einen Parameter für den Wert des Schlüssel/Wert-Paares des Headers zuzuweisen, wählen Sie Als Aufgabenparameter angeben aus. Siehe Headerwert parametrisieren.

Header bearbeiten

Sie können den Schlüssel und Wert eines Headers bearbeiten.

Wenn der Headerwert parametrisiert ist, bearbeiten Sie den Parameter, um den Standardparameterwert zu ändern. Siehe Wert eines parametrisierten Headers bearbeiten.

So bearbeiten Sie Schlüssel/Wert-Paare im Header:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren im Schritt Ausführungsdetails definieren die Option Header aus, um einen Header in der REST-Aufgabe zu bearbeiten.

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

  2. Wählen Sie in der Tabellenzeile für einen Header im Menü "Aktionen" die Option Bearbeiten aus (Menü Aktionen).
  3. Ändern Sie im Bereich "Header bearbeiten" die Werte in den Feldern Schlüssel und Wert, und wählen Sie Speichern aus.

    Wenn Sie mit der Eingabe eines Wertes in einem der beiden Felder beginnen, wird eine Liste mit Vorschlägen in einem Menü angezeigt, wenn ein übereinstimmendes Element gefunden wird. Dann können Sie den gewünschten Headerschlüssel oder Headerwert auswählen.

    Hinweis

    Wenn der Wert im Feld Wert eine Parameterzeichenfolge wie ${PARAMETER_HEADER} ist und Sie die Zeichenfolge mit einem Headerwert überschreiben, der mit dem Schlüssel übereinstimmt, wird der Parameter entfernt, wenn Sie Speichern auswählen. Um den Headerwert erneut zu parametrisieren, wählen Sie Als Aufgabenparameter angeben aus, wie unter Headerwert parametrisieren beschrieben.

Header löschen

Beim Löschen eines Headers wird das Schlüssel/Wert-Paar des Headers aus der REST-Aufgabe entfernt.

So löschen Sie einen Header:

  1. Wählen Sie auf der Seite REST-API-Details konfigurieren im Schritt Ausführungsdetails definieren die Option Header aus, um einen Header in der REST-Aufgabe zu löschen.

    Um einen Header für die Polling- oder Beendigungs-URL zu löschen, gehen Sie zur Seite Abschlusskriterien angeben. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Header aus.

  2. Wählen Sie in der Tabellenzeile für einen Header im Menü "Aktionen" die Option Löschen aus (Menü Aktionen).
  3. Wählen Sie im Dialogfeld "Header löschen" die Option Löschen aus.

    Das Schlüssel/Wert-Paar des Headers wird aus der Headertabelle entfernt.

    Hinweis

    Wenn der Headerwert parametrisiert wurde, wird der Parameter, der dem Headerwert zugeordnet war, nicht gelöscht. Informationen zum Löschen des Parameters finden Sie unter REST-Aufgabenparameter löschen.
Headerwert parametrisieren

Nachdem Sie das Schlüssel/Wert-Paar für einen Header definiert haben, können Sie dem Headerwert einen Aufgabenparameter zuweisen.

So parametrisieren Sie den Headerwert einer Kopfzeile:

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

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

  2. Wählen Sie in der Tabellenzeile für einen Header neben dem Headerwert die Option Als Aufgabenparameter verfügbar aus.
  3. Geben Sie im Bereich Parameter hinzufügen einen Namen für den Parameter in das Feld ID 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 ist "Zeichenfolge". Sie können den Datentyp nicht ändern.
  6. Stellen Sie die Länge ein.
  7. Geben Sie den Standardwert für den Parameter ein.
    Der Standardheaderwert wird zur Laufzeit verwendet, wenn Sie den Wert nicht zur Entwurfs- oder Laufzeit ändern.
  8. Wählen Sie Hinzufügen aus.
    Die Tabellenzeile des Headers wird mit dem Parameternamen neben dem Headerwert aktualisiert.
Wert eines parametrisierten Headers bearbeiten

Sie können nur den Standardwert des Parameters ändern.

So bearbeiten Sie den Standardwert für einen parametrisierten Headerwert:

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

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

  2. Wählen Sie in der Tabellenzeile für den Headerwert, den Sie ändern möchten, neben dem Parameternamen Parameter bearbeiten aus.
  3. Ändern Sie im Bereich "Parameter bearbeiten" den Parameterwert.
  4. Wählen Sie Speichern aus.
Headerwertparameter entfernen

Wenn Sie einen Headerwertparameter entfernen, wird nur die Verknüpfung des Parameters mit dem Headerwert des Headers entfernt.

Das Schlüssel/Wert-Paar für den Header wird beim Entfernen des Headerwertparameters nicht gelöscht.

So entfernen Sie einen Headerwertparameter:

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

    Um einen Headerwertparameter für die Polling- oder Beendigungs-URL zu entfernen, gehen Sie zur Seite Abschlusskriterien angeben. Wählen Sie auf der Registerkarte Polling oder Austritt die Option Header aus.

  2. Wählen Sie in der Tabellenzeile für den Headerwertparameter, den Sie entfernen möchten, Parameter entfernen aus.
  3. Wählen Sie im Dialogfeld "Parameter entfernen" die Option Entfernen aus.

    Die Zuweisung des Parameters zum Headerwert des Headers wird aufgehoben. Der dem Parameter zugewiesene Wert wird zum Headerwert.

    Hinweis

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