REST-Dienst aufrufen

Symbol "REST-Dienst aufrufen"

Rest-Dienst aufrufen
Mit dieser Workflow-Aktivität können Administratoren externe Webdienste von einer automatischen Workflow-Aktivität aus aufrufen, ohne dass dazu Code geschrieben werden muss.

Allgemeine Einstellungen
Nähere Informationen zu den allgemeinen Einstellungen von Workflow-Aktivitäten finden Sie hier:
Workflow-Aktivitäten

Bearbeiten
Öffnet ein Dialogfeld, in dem Sie die Einstellungen für REST-Aufrufe konfigurieren können.

Symbol Beschreibung
Symbol "Neue Anfrage"

Einen neuen REST-Aufruf hinzufügen.

Symbol "Anfrage bearbeiten"

Einen REST-Aufruf bearbeiten.

Symbol "Anfrage löschen"

Einen REST-Aufruf löschen.

Symbol "Nach oben"

Den REST-Aufruf in der Liste nach oben verschieben. Standardmäßig werden Aufrufe von oben nach unten nacheinander ausgeführt.

Symbol "Nach unten"

Den REST-Aufruf in der Liste nach unten verschieben.

Name
Geben Sie einen Namen für den REST-Aufruf ein.

Skript-ID
Geben Sie eine Skript-ID für den REST-Aufruf ein.

Zugangsdaten
Wählen Sie gespeicherte Zugangsdaten aus dem zentralen Zugangsdatenspeicher, um sich bei dem Anbieter des Endpunkts zu authentifizieren, an den der Aufruf erfolgt.
Zugangsdaten

Verb
Wählen Sie die HTTP-Anfragemethode aus der Dropdownliste aus.

Optionen in der Dropdownliste:

Anfrage Funktion

GET

Ruft Daten von einem Server an der angegebenen Ressource ab.

POST

Sendet Daten an den API-Server, um eine Ressource zu erstellen oder zu aktualisieren.

PUT

Sendet Daten an die API, um eine Ressource zu aktualisieren oder zu erstellen. Der Unterschied besteht darin, dass PUT-Anfragen immer das gleiche Ergebnis liefern.

DELETE

Löscht die Ressource an der angegebenen Ressource.

PATCH

Ähnlich wie POST und PUT, gilt aber nur für teilweise Änderungen an der Ressource.

URL-Feld
Der Platzhalter für den URL des Webdienst-Aufrufs.

Makros
Öffnet ein Dialogfeld mit allen verfügbaren Makros.

Skript
Sie können ein Initialisierungsskript erstellen, das vor der Feldzuweisung ausgeführt wird. Sie können hier auch Variablen und Funktionen definieren, die dann für die Zuweisungsskripte verfügbar sind.

Testen
Führt einen API-Testaufruf aus, der überprüft, ob die Kommunikation mit dem Webdienst möglich ist und ob eine Antwort erreicht werden kann. Öffnet ein Dialogfeld, in dem das Ergebnis des Tests angezeigt wird.

Parameter
Listet die Parameter auf, die zum Senden und Empfangen erforderlich sind.

Hinzufügen
Einen Parameter hinzufügen.

Entfernen
Einen Parameter entfernen.

Kopfzeile
Listet die Kopfzeilen auf, die zum Senden und zum Empfang erforderlich sind.

Dokument
Wenn ein Dokument über den REST-Aufruf an einen externen Dienst gesendet werden soll, konfigurieren Sie den Inhalt und die Sendemethode.

Textkörper
Listet die JSON-Werte und -Objekte auf.

Einfügen
Wählen Sie ein JSON-Objekt oder einen JSON-Wert aus, das/der aufgelistet werden soll.

Entfernen
Entfernt ein JSON-Objekt/einen JSON-Wert.

JSON-Anfrage laden
Eine JSON-Datei in den Textkörper hochladen. JSON-Code kann entweder aus einer Datei auf Ihrem Gerät oder direkt aus der Zwischenablage eingefügt werden.

Antwort
Definieren Sie die Antwort, die vom externen Dienst empfangen werden soll.

Erfolgscodes
Listet die Codes auf, die der API-Aufruf als Erfolgscodes ansehen sollte.

Skript
Sie können ein Initialisierungsskript erstellen, das vor der Feldzuweisung ausgeführt wird. Sie können hier auch Variablen und Funktionen definieren, die dann für die Zuweisungsskripte verfügbar sind.

JSON-Antwort laden
Eine JSON-Datei in den Textkörper hochladen. Die JSON-Antwort kann entweder aus einer Datei auf Ihrem Gerät geladen oder direkt aus der Zwischenablage eingefügt werden.

Info-Symbol

Hinweis:

  • REST-Aufrufe sind für abgehende Aufrufe an externe Anwendungen konzipiert. Obwohl es möglich ist, REST-Aufrufe zum Aufrufen der Therefore-API zu verwenden, um erweiterte Anforderungen zu erfüllen, ist diese Funktion eingeschränkt, besonders bei der Arbeit mit Indexdaten.

  • Damit externe Anwendungen unter Umgehung der zweistufigen Authentifizierung auf Therefore™ zugreifen können, benötigen sie ein Dienstkonto. Weitere Informationen finden Sie in unserer nachfolgenden Referenz:
    Benutzer und Gruppen