Beschreibung der REST-Methoden zur Verarbeitung von Aufgaben
PAAS funktioniert auch als Webdienst. Sie können auf Methoden zugreifen, um Berichte zu erhalten, mit dem Dokumentensystem zu arbeiten und Workflows zu verwalten.
In diesem Kapitel finden Sie die folgenden REST-Methoden zur Verarbeitung von Aufgaben und deren Beschreibungen:
1. Erstellen einer neuen Verarbeitungsaufgabe
2. Abrufen des Status einer bestehenden Aufgabe
3. Herunterladen einer einzelnen Ergebnisdatei
1. Erstellen einer neuen Verarbeitungsaufgabe
POST /api/v1/:datenbank/process/:befehl
Parameter:
- datenbank: SQL Server-Datenbank, in der die Aufgabe ausgeführt werden soll;
- befehl: Befehl, der auf PAAS ausgeführt werden soll;
- body: sollte JSON-Parameter für die neue Aufgabe enthalten.
Gibt zurück: JSON-Objekt mit zwei Feldern;
- task: numerische Aufgaben-ID
- runner: String-Aufgaben-Token
Beispiele für das Erstellen einer neuen Verarbeitungsaufgabe:
 |
Diese Methode plant eine Aufgabe zur Ausführung und gibt sofort zurück. Die Parameter :befehl und :body werden in der Tabelle ‘tPA_PAASProcessing’ wie gesendet gespeichert. |
Die tatsächliche Ausführung erfolgt durch ‘PANTHEON.exe’. PAAS startet PANTHEON, wenn es noch nicht läuft, oder benachrichtigt ein bereits laufendes PANTHEON-Programm, dass eine verfügbare Aufgabe zur Ausführung vorliegt.
2. Abrufen des Status einer bestehenden Aufgabe
GET /api/v1/:datenbank/status/:aufgabe?guid=:runner
Parameter:
Datenbank: SQL Server-Datenbank, in der die Aufgabe ausgeführt wird: Aufgaben-ID wird in die Datei erstellt; guid 'runner' wird empfangen, wenn die Aufgabe erstellt wurde.
Gibt zurück status aus der Tabelle ‘tPA_PAASProcessing’ für die gegebene Aufgabe:
{ "id": numerische Aufgaben-ID (anQId) "status": num status (anStatus): 0: ausstehend, 102: in Bearbeitung, 200: erfolgreich abgeschlossen, 400: Fehler "lane": String-Name der Prioritätslane, in der die Aufgabe ausgeführt wird (derzeit ungenutzt) "command": String angeforderter Aufgabenbefehl (Drucken, Workflow, ...) (acCommand) "result": JSON mit Ergebnissen. zurückgegeben von Pantheon (acResult), wenn die Aufgabe abgeschlossen ist
{ "guid": guid des Aufgabenprozessors (derzeit ungenutzt), wenn der Status OK ist "files": Array von Strings ["full\\path1\\to_file1.ext", full\\path1\\to_file1.ext"] "error": Fehler-Stringbeschreibung, falls ein Fehler aufgetreten ist } }
Beispiel für das Abrufen des Status einer bestehenden Aufgabe
3. Herunterladen einer einzelnen Ergebnisdatei
GET /api/v1/:datenbank/download/:aufgabe/:datei?guid=:guid
Parameter:
- Datenbank: SQL Server-Datenbank, in der die Aufgabe ausgeführt und erfolgreich abgeschlossen wurde.
- Aufgabe: Aufgaben-ID der erstellten Datei.
- Datei: numerische Reihenfolge der Datei aus dem Dateien-Array im Status > Ergebnis > Dateien.
- Guid: ‘runner’, der empfangen wurde, als die Aufgabe erstellt wurde.
Gibt zurück: Dateiinhalt.
Beispiel für das Herunterladen einer einzelnen Ergebnisdatei
Verwandte Themen: