Verwenden Sie die Registerkarte „Anfrageparameter“, um verschiedene Parameter wie Pfad und Abfrage zu Ihren Anfragen hinzuzufügen. Vergewissern Sie sich, dass die hinzugefügten Parameter mit den Parametern übereinstimmen, die in der Endpunkt-URL verwendet werden.

Aktionen

Die folgenden Anforderungsparameter-Aktionen sind aktiviert:

Hinzufügen
Um Parameter zur Anfrage hinzuzufügen.
Klicken Sie auf das Symbol Hinzufügen, um einen Parameter hinzuzufügen. Die Anzahl der Parameter, die im Titel der Parameter-Tabelle angezeigt wird, wird automatisch aktualisiert.
Bearbeiten
Um die vorhandenen Parameter zu bearbeiten, die in der Anfrage verfügbar sind.
In der Parametertabelle fahren Sie mit der Maus über das vertikale Auslassungszeichen des entsprechenden Parameters und klicken Sie auf das Bearbeiten-Symbol, um den Parametertyp, den Schlüssel, den Wert oder den Werttyp zu bearbeiten.
Löschen
Um die in der Anfrage verfügbaren Parameter zu löschen.
Führen Sie eine der folgenden Aktionen aus, um Parameter zu löschen:
  • Klicken Sie auf das Kontrollkästchen Alle auswählen in der Tabellenüberschrift und dann auf das Symbol Löschen, das über der Tabelle verfügbar ist, um mehrere Parameter zu löschen.
  • Bewegen Sie den Mauszeiger über das vertikale Ellipsenmenü jedes Parameters und klicken Sie dann auf das Löschen-Symbol, um den Parameter einzeln zu löschen.

Parametertabelle

Sehen Sie sich Parameterdetails in der folgenden Tabelle an.

Spalte Beschreibung
Typ Zeigt den Typ des Parameters an. Der Parameter kann ein Abfrage-Parameter oder ein Pfad-Parameter sein. Der Paketnutzer kann den Parametertyp im Bot Editor oder API-Aufgaben-Editor nicht sehen.
Schlüssel Zeigt den Parameter-Schlüssel an. Der Paketnutzer kann den Schlüssel im Bot Editor oder API-Aufgaben-Editor nicht sehen. Der Schlüssel 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.
Wert wird vom Nutzer bereitgestellt Zeigt den Status des Werts an.
  • Ja: Wenn der Wert vom Nutzer bereitgestellt wird. Der Paketnutzer muss einen entsprechenden Wert angeben, wenn er den Parameter im Bot Editor oder API-Aufgaben-Editor konfiguriert.
  • Nein: 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.
Benennung Zeigt das Parameterlabel für Werte, die Von Nutzer bereitgestellt wurden, an. Der Paketnutzer kann das Parameter-Label im Bot Editor oder API-Aufgaben-Editor sehen.
Beschreibung Zeigt die Parameterbeschreibung an. Der Paketnutzer kann die Parameterbeschreibung im Bot Editor oder API-Aufgaben-Editor sehen.

Anforderungsparameter hinzufügen

Führen Sie diese Schritte aus, um einen Anforderungsparameter hinzuzufügen:

  1. Klicken Sie auf die Registerkarte Anforderungsparameter im Bereich Konfiguration.
  2. Klicken Sie auf Parameter hinzufügen oder auf das Plus-Symbol (+) am oberen Rand der Tabelle, um einen Parameter hinzuzufügen.
  3. Führen Sie Folgendes im Modal Parameter hinzufügen aus.
    1. Parametertyp: Wählen Sie eine der folgenden Optionen 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}.
    2. Schlüssel: Geben Sie 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.
    3. Wählen Sie eine der folgenden Optionen im Abschnitt Wert wird:
      Typ Beschreibung
      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. Werteingabetyp: Aktivieren Sie dieses Kontrollkästchen, wenn Sie den Typ des Eingabewe sichern möchten. Wenn Sie das Kontrollkästchen aktivieren, können Sie den Parameter über Anmeldedaten, eine Variable oder eine unsichere Zeichenfolge eingeben.
      2. Ist dieses Feld obligatorisch? Wählen Sie Nein oder Ja, je nach den Anforderungen des Parameters.
      3. Wert (optional): Geben Sie einen Wert ein. Der Paketnutzer kann diesen Wert im Bot Editor oder API-Aufgaben-Editor sehen und aktualisieren.
      4. Bezeichnung: Geben Sie eine Bezeichnung für den Parameter ein. Der Paketnutzer kann das Parameter-Label im Bot Editor oder API-Aufgaben-Editor sehen.
      5. Beschreibung (optional): Geben Sie eine Beschreibung für den Parameter ein. Der Paketnutzer kann die Parameterbeschreibung im Bot Editor oder API-Aufgaben-Editor sehen. Die Beschreibung wird als Hilfetext im Editor angezeigt.
  4. Klicken Sie auf Hinzufügen, um den Parameter zur Anfrage hinzuzufügen.

    Der neue Parameter wird in der Parameter-Tabelle angezeigt und die Parameteranzahl im Tabellentitel wird automatisch aktualisiert.

Wiederholen Sie die Schritte, um weitere Parameter hinzuzufügen.