Platzhalter
Damit Daten dynamisch in Endpunkte einfliessen können, kann mit sogenannten Platzhaltern gearbeitet werden. Diese Platzhalter können flexibel definiert und im Workflow Builder mit Variablen verknüpft werden. Bei der Ausführung des Workflows wird der Platzhalter durch den tatsächlichen Wert der zugewiesenen Variable ersetzt.
Ein Platzhalter muss im Format ${platzhalter} definiert werden, wobei der Name des Platzhalters zwischen den geschweiften Klammern {} angegeben wird. Der Name kann dabei beliebig gewählt werden, was eine hohe Flexibilität bei der Verwendung von Platzhaltern ermöglicht.
Einsatz von Platzhaltern
Platzhalter können an verschiedenen Stellen innerhalb der API Spezifikation verwendet werden, um dynamische Werte zur Laufzeit zu integrieren. Die möglichen Einsatzorte für Platzhalter sind:
Hostname der API: Der Hostname, also die Basis-URL der API, kann mit einem Platzhalter versehen werden, der zur Laufzeit durch den entsprechenden Wert ersetzt wird.
Wert eines Headers: Platzhalter können auch in den Headern eines HTTP-Requests verwendet werden, sodass zum Beispiel ein Authentifizierungstoken oder ein benutzerdefinierter Header dynamisch ersetzt wird.
Pfad des Endpunkts: Der Pfad, also die URL des Endpunkts, zu dem die Anfrage gesendet wird, kann ebenfalls Platzhalter enthalten, die durch Variablen ersetzt werden.
Body des Requests: Der Inhalt (Body) des HTTP-Requests kann mit Platzhaltern versehen werden, um Daten, wie z. B. Benutzereingaben oder dynamisch generierte Werte, zu übermitteln.
Diese Platzhalter bieten eine hohe Flexibilität, da Sie die API-Aufrufe dynamisch anpassen können, basierend auf den zur Verfügung stehenden Variablen im Workflow.
Beispiel
Der folgende Endpunkt hat zwei Platzhalter im Pfad und einen im Request-Body definiert:
Wird dieser Endpunkt im Workflow Builder mit dem Plugin API Endpunkt aufrufen verwendet, so muss für die drei Platzhalter userId, ticketId und description eine Variable ausgewählt werden. Der tatsächliche Wert der Variablen zur Laufzeit wird dann anstellte der Platzhalter eingefügt.
Zuletzt aktualisiert