Sie können eine Extraktion via Webservice-Aufruf ausführen. Der Aufruf einer Extraktion erfolgt in der Regel über ein Skript, Scheduler oder BI-Tool.

Basis-URL-Format #

Die Basis-URL für Webaufrufe verwendet das folgende Format: [protocol]://[host or IP address]:[port]/.

Beispiele

Protokoll Syntax Beispiel
HTTP http://[host].[domain]:[port] http://sherri.theobald.local:8065
HTTP http://[host]:[port] http://localhost:8065
HTTPS https://[host].[domain]:[port] https://sherri.theobald.local:8165
Erfordert einen dedizierten Hostnamen und ein X.509-Zertifikat, siehe Web Server Einstellungen.

Hinweis: Stellen Sie sicher, dass Sie die richtigen Ports verwenden, siehe Server-Ports.

Extraktionen ausführen # 

[protocol]://[host]:[port]/run/[extraction_name]

Führt die angegebene Extraktion aus und wartet darauf, dass der Prozess angeschlossen ist.

[protocol]://[host]:[port]/start/[extraction_name]

Führt die angegebene Extraktion asynchron aus und gibt den Ausführungsstatus sofort zurück.

Warnung! Veraltete Endpunkte:
[protocol]://[host]:[port]/?name=[extraction_name] (synchron)
[protocol]://[host]:[port]/?name=[extraction_name]&wait=false (asynchron)

Tipp: Sie können die Benutzeroberfläche im Menü “Run Extraction” verwenden, um eine URL für das Ausführen einer Extraktion zu generieren, siehe Extraktion ausführen.

Antwort

Die Antwort eines Webservice-Aufrufs enthält die folgenden Informationen:

  Antwort Beschreibung
(1) HTTP Statuscode Der HTTP-Statuscode 200 zeigt einen erfolgreichen Extraktionsaufruf an. Dies weist nicht auf eine erfolgreiche Ausführung der Extraktion hin.
Der HTTP-Statuscode 404 zeigt an, dass die aufgerufene Extraktion nicht existiert. Detaillierte Informationen finden Sie im Protokoll des Webservices.
(2) HTTP-Header Zeigt den Zeitstempel der Extraktion im HTTP-Header an, z. B., X-XU-Timestamp: 2021-04-09_19:03:09.971
(3) HTTP Response-Body Die Antwort im HTTP-Body hängt vom Typ der Destination der Extraktion ab. Abhängig vom Destinationstyp werden die extrahierten Daten entweder im CSV-oder JSON-Format zurückgegeben.

Webservice Call pull

Parameter

[protocol]://[host]:[port]/start/[extraction_name]

Parameter Beschreibung
&[parameter1_name]=[value] Führt die angegebene Extraktion aus und übergibt Werte an die angegebenen Extraktionsparameter.
&quiet-push=true Führt die angegebene Extraktion aus und unterdrückt die Ausgabe von Extraktionsprotokollen für Push-Destinationen. Dieser Parameter hat keine Auswirkung auf Pull-Destinationen und asynchrone Extraktionen.

Beispiel

http://sherri.theobald.local:8065/start/KNA1/?name1=heobald%20Software&city=Stuttgart

Click here to show the response body 
KUNNR,LAND1,NAME1,ORT01
0000000779,DE,Theobald Software,Stuttgart

Extraktion abbrechen # 

[protocol]://[host]:[port]/abort?name=[extraction_name]

Bricht die angegebene Extraktion ab. Bei erfolgreichem Abbruch wird im HTTP-Body eine Bestätigungsmeldung zurückgegeben.

* Dieser Endpunkt ist als veraltet markiert und wird durch /stop/[extraction_name] ersetzt. *

Beispiel

http://sherri.theobald.local:8065//abort?name=KNA1

Click here to show the response body 
All runs of extraction 'KNA1' aborted.