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
	Einen neuen REST-Aufruf hinzufügen.
	Einen REST-Aufruf bearbeiten.
	Einen REST-Aufruf löschen.
	Den REST-Aufruf in der Liste nach oben verschieben. Standardmäßig werden Aufrufe von oben nach unten nacheinander ausgeführt.
	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.

Test
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.

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.

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

Skripte – Objekte und Funktionen

Art des Objekts	Name	Beschreibung	Verwendet mit
REST-Aufruf	Statuscode	Liefert den aktuellen Statuscode zurück.	Skript
	GetResponseHeader
	NextRequest
	ExecCounter
	ExitSuccess
	ScriptError
Indexdatenobjekt	SetField	Legt den Wert des Indexdatenfelds fest.	Skript
	GetField	Ruft den aktuellen Indexdatenwert des angegebenen Felds ab	Skript
	GetFieldEx	Ruft den aktuellen Indexdatenwert des angegebenen Felds ab, ohne rückwärtskompatible Konvertierungen anzuwenden	Skript
	SetCategory	Ruft die Kategorie des aktuellen Dokuments ab. Sie können eine Ganzzahl (Kategorie-ID) oder eine Zeichenfolge (Kategoriename) verwenden.	Skript
	SetCaseNo	Legt die Aktennummer für dieses Indexdatenobjekt fest.	Skript
	GetCategoryName	Ruft den Kategorienamen ab, zu dem das Indexdatenobjekt gehört.	Skript
	GetTableValue	Ruft den aktuellen Indexdatenwert des angegebenen Felds aus der angegebenen Zeile ab.	Skript
	SetTableValue	Richtet den Wert des Indexdatentabellenfelds in der angegebenen Zeile ein.	Skript
Workflow-Objekt	AssignedToUserDisplayName	Liefert den Anzeigenamen des Benutzers zurück, dem die Aktivität zugewiesen ist.	Skript
	AssignedToUserName	Liefert den Benutzernamen des Benutzers zurück, dem die Aktivität zugewiesen ist.	Skript
	InitiatorDisplayName	Liefert den Anzeigenamen des Benutzers zurück, der den Workflow initiiert hat.	Skript
	InitiatorEmail	Liefert die E-Mail-Adresse des Benutzers zurück, der den Workflow initiiert hat.	Skript
	InitiatorName	Liefert den Benutzernamen des Benutzers zurück, der den Workflow initiiert hat.	Skript
	InstanceNo	Liefert die Instanznummer für diesen Workflow zurück.	Skript
	MainDocNo	Liefert die Dokumentnummer des Hauptdokuments in diesem Workflow zurück.	Skript
	PreviousTaskUserDisplayName	Liefert den Anzeigenamen des Benutzers zurück, der die vorherige Aktivität abgeschlossen hat.	Skript
	PreviousTaskUserEmail	Liefert die E-Mail-Adresse des Benutzers zurück, der die vorherige Aktivität abgeschlossen hat.	Skript
	PreviousTaskUserDomain	Liefert die Domäne des Benutzer zurück, der die vorherige Aktivität abgeschlossen hat	Skript
	PreviousTaskUserName	Liefert den Benutzernamen des Benutzers zurück, der die vorherige Aktivität abgeschlossen hat	Skript
	ProcessDueDateTime	Liefert das Datum und die Uhrzeit für die Fälligkeit des Workflow-Prozesses zurück.	Skript
	ProcessDueDate	Liefert das Fälligkeitsdatum des Workflow-Prozesses zurück.	Skript
	ProcessName	Liefert den Namen des Workflow-Prozesses zurück.	Skript
	ProcessStartDate	Liefert das Startdatum des Workflow-Prozesses zurück.	Skript
	ProcessStartDateTime	Liefert das Datum und die Uhrzeit für den Start des Workflow-Prozesses zurück.	Skript
	ServerName	Liefert den Namen des Computers zurück, auf dem die Workflow-Aktivität ausgeführt wird.	Skript
	TaskDueDate	Liefert das Fälligkeitsdatum der Aktivität zurück.	Skript
	TaskDueDateTime	Liefert das Datum und die Uhrzeit für die Fälligkeit der Aktivität zurück.	Skript
	TaskNameTo	Liefert den Namen der nächsten Aktivität zurück.	Skript
	TaskStartDate	Liefert das Startdatum der Aktivität zurück.	Skript
	TaskStartDateTime	Liefert das Datum und die Uhrzeit für den Start der Aktivität zurück.	Skript
	UserDisplayName	Liefert den Anzeigenamen des Workflow-Benutzers zurück.	Skript
	UserDomain	Liefert den Domänennamen des Workflow-Benutzers zurück.	Skript
	UserEmail	Liefert die E-Mail-Adresse des Workflow-Benutzers zurück.	Skript
	UserName	Liefert den Benutzernamen des Workflow-Benutzers zurück.	Skript
	WebClientDocLink	Liefert einen Link zum Hauptdokument des Workflows zurück.	Skript
	WebClientLink	Liefert einen Link zum Therefore™-Dokument des Workflows zurück.	Skript
	WebPortalDocLink	Liefert einen Link zum Hauptdokument des Workflows im Portal zurück	Skript
	CaseNo	Liefert die Aktennummer für einen Akten-Workflow zurück.	Skript
	TenantName	Liefert den Namen des Mandanten zurück.	Skript
	EFormLink	Liefert den Root-Link für die Therefore™ E-Formulare zurück.	Skript
	WebClientLinkDynamicView	Liefert einen Link zur Workflow-Instanz in der neueren Version des Therefore™ Web Clients zurück.	Skript
	WebClientDocLinkDynamicView	Liefert einen Link zum Hauptdokument der Workflow-Instanz in der neueren Version des Therefore™ Web Clients zurück.	Skript
	CategoryNo	Liefert die Nummer der Kategorie zurück, in der der Workflow ausgeführt wird.	Skript
	CaseDefNo	Liefert die Nummer der Aktendefinition zurück, in der der Workflow ausgeführt wird.	Skript
	eSignatureDocID	Liefert die letzte Dokument-ID zurück, die von diesem E-Signaturanbieter ausgegeben wurde.	Skript
	InitiatorDomain	Liefert die Domäne des Benutzers zurück, der den Workflow initiiert hat.	Skript
	TokenNo	Liefert die Tokennummer der Workflow-Instanz zurück.	Skript
	AddCommentToWorkflow	Fügt einen Kommentar zur Workflow-Instanz hinzu.	Skript
	GetAccessToken	Generiert ein Zugriffstoken, um die Workflow-Instanz, das Hauptdokument oder die Akte über die Web-API zu öffnen. Sie können de erwartete Lebensdauer in Minuten festlegen. Die maximale Lebensdauer beträgt 60 Minuten.	Skript
	GetDocumentText	Ruft den Rohtextinhalt eines Dokuments ab. Unterstützt einen zusätzlichen Parameter - StreamNo: Der Standardwert ist 0, womit der Text aller Streams zurückgeliefert wird. Wenn Sie eine bestimmte Stream-Nummer angeben, wird nur der Rohtext aus diesem Stream zurückgeliefert. Diese Funktion kann kein OCR ausführen.	Skript
Helfer	ToDate	Konvertiert eine Zeichenfolge im angegebenen Format in ein Datum mit "D", "M" und "Y" für Tag, Monat und Jahr. Trennzeichen werden streng interpretiert.	Skript
	ToFloat	Konvertiert eine Zeichenfolge im angegebenen Format in eine Gleitkommazahl.	Skript
	ToDecimal	Konvertiert eine Zeichenfolge im angegebenen Format in eine Dezimalzahl.	Skript
	ToDateTime	Wandelt eine Zeichenfolge über die angegebene LCID in ein Datum und eine Uhrzeit um.	Skript
	DecimalAdd	Addiert eine Dezimalzahl zu einer anderen. (decimal1 + decimal2)	Skript
	DecimalSub	Subtrahiert eine Dezimalzahl von einer anderen. (decimal1 - decimal2)	Skript
	DecimalMul	Multipliziert eine Dezimalzahl mit einer anderen. (decimal1 * decimal2)	Skript
	DecimalDiv	Dividiert eine Dezimalzahl durch eine andere. (decimal1 / decimal2)	Skript
	DecimalCmp	Vergleicht zwei Dezimalzahlen miteinander. Liefert 0 zurück, wenn sie gleich sind. Liefert -1 zurück, wenn decimalLeft kleiner als decimalRight ist. Liefert 1 zurück, wenn decimalLeft größer als decimalRight ist.	Skript
	AdjustClientTimeDifference	Liefert die Servereinstellung "Zeitunterschied der Clients" zurück. Dieser Wert kann zu einem bestehenden Datetime-Wert addiert werden, um die Zeitzone des Clients zu berechnen.	Skript
	Datum	Liefert das heutige Datum zurück.	Skript
	GetSystemVariable	Liefert den Wert der angegebenen Systemvariablen zurück.	Skript