Anforderungsparameter

Verwenden Sie den Abschnitt „Anfrageparameter“, um verschiedene Parameter wie Pfad und Abfrage zu Ihren Anfragen hinzuzufügen. Stellen Sie sicher, dass diese Parameter mit den Parametern übereinstimmen, die in der Endpunkt-URL verwendet werden.

Aktionen

Die folgenden Anforderungsparameter-Aktionen sind aktiviert:

Hinzufügen
Klicken Sie hierauf, um einen Parameter hinzuzufügen.
Bearbeiten
Bewegen Sie die Maus über das Symbol mit den drei Punkten für den Parameter, den Sie bearbeiten möchten, und klicken Sie auf das Bearbeitungssymbol.
Löschen
Löscht die ausgewählten Parameter.

Parametertabelle

Sehen Sie sich Parameterdetails in der folgenden Tabelle an.

Tabellenelement Beschreibung
Typ Zeigt an, ob der Parameter ein Abfrageparameter oder ein Typparameter ist. Der Parametertyp wird dem Paketnutzer im Bot Editor oder API-Aufgaben-Editor nicht angezeigt.
Wert wird vom Nutzer bereitgestellt Zeigt an, ob der Wert vom Nutzer bereitgestellt wird.
  • Zeigt Ja an, wenn der Wert vom Nutzer bereitgestellt wird. Der Paketnutzer muss einen entsprechenden Wert angeben, wenn er diesen Parameter im Bot Editor oder API-Aufgaben-Editor konfiguriert.
  • Zeigt Nein an, wenn der Wert hartcodiert ist. Der Paketnutzer kann diesen Wert im Bot Editor oder API-Aufgaben-Editor nicht sehen. Dieser Wert wird als Teil des Headers gesendet.
Schlüssel Zeigt den Schlüsselnamen an. Der Schlüsselname wird dem Paketnutzer im Bot Editor oder API-Aufgaben-Editor nicht angezeigt. Dieser Name wird als Teil des Headers gesendet.
Wert Zeigt den Parameterwert an. Der Paketnutzer kann diesen Wert im Bot Editor oder API-Aufgaben-Editor sehen und aktualisieren.
Benennung Zeigt die Parameterbezeichnung an. Der Paketnutzer kann diese Bezeichnung für den Parameter im Bot Editor oder API-Aufgaben-Editor sehen.
Beschreibung Zeigt die Parameterbeschreibung an. Der Paketnutzer kann diese Beschreibung für den Parameter im Bot Editor oder API-Aufgaben-Editor sehen.

Anforderungsparameter hinzufügen

  1. Klicken Sie auf die Registerkarte Anforderungsparameter.
  2. Klicken Sie auf Parameter hinzufügen oder auf das Plus-Symbol (+) am oberen Rand der Tabelle, um einen Parameter hinzuzufügen.
  3. Wählen Sie im Fenster Parameter hinzufügen einen der folgenden Parametertypen aus:
    • Abfrage: Diese Parameter werden an den URL-Pfad nach einem ?-Zeichen angehängt. Beispiel: /accounts?user_account=company.
    • Pfad: Diese Parameter werden direkt an den URL-Pfad angehängt. Beispiel: /accounts/{user_account}.
  4. Geben Sie in das Feld Schlüssel einen geeigneten Schlüsselnamen ein. Der Schlüsselname wird dem Paketnutzer im Bot Editor oder API-Aufgaben-Editor nicht angezeigt. Dieser Name wird als Teil des Headers gesendet.
  5. Wählen Sie eine der folgenden Optionen aus:
    Hartcodiert Geben Sie einen Wert ein, der für den Parameter hartcodiert ist. Der Paketnutzer kann diesen Wert im Bot Editor oder API-Aufgaben-Editor nicht sehen. Dieser Wert wird als Teil des Headers gesendet.
    Vom Nutzer bereitgestellt
    1. Wählen Sie, ob der Eingabewerttyp gesichert werden soll. Wenn Sie auswählen, dass er gesichert werden soll, können Sie den Parameter über Anmeldedaten, eine Variable oder eine unsichere Zeichenfolge eingeben.
    2. Wählen Sie, ob dieses Feld obligatorisch ist.
    3. Geben Sie einen Wert ein. Der Paketnutzer kann diesen Wert im Bot Editor oder API-Aufgaben-Editor sehen und aktualisieren.
    4. Geben Sie eine Bezeichnung ein. Der Paketnutzer kann diese Bezeichnung für den Parameter im Bot Editor oder API-Aufgaben-Editor sehen.
    5. (Optional) Geben Sie eine Beschreibung ein. Der Paketnutzer kann diese Beschreibung für den Parameter im Bot Editor oder API-Aufgaben-Editor sehen. Sie wird als Hilfetext im Editor angezeigt.