Inhaltsverzeichnis
Verwaltung von Jobs
Neben dem Hochladen (Upload) von Jobs und dem Abrufen (Download) von Jobs gibt es weitere Methoden zur Verwaltung von Jobs.
Es ist eine HTTP-Auth-Anmeldung mit einem dStore-User für alle diese Methoden erforderlich.
jobqueue
Liefert eine Liste mit allen Jobs in der Queue zur angegebenen Schnittstelle. Für die „_out“-Schnittstellen werden die Dateien nach dem 1. Abruf in den Sicherung-Ordner („bak“) verschoben. Die URL lautet:
https://<Partner>-<Projekt>.dstore.de/xml/jobqueue
Pflichtparameter
- Interfacename : Name der Schnittstelle, also in der Regel „orders_out“, „persons_out“. Es können natürlich auch die Queue-Listen von „_in“-Schnittstellen abgerufen werden.
Rückmeldung
Die Rückmeldung aller im Erfolgsfall ist
- HTTP-Status 200 OK
- Body (text/plain) mit dem Inhalt des Warteschleife („queue“), ein Jobname pro Zeile.
joblog
Liefert das kurze (Standard-)Log für den angegebenen Job und Schnittstelle. Dies Log ist erst nach einer erfolgreichen Verarbeitung des Jobs verfügbar. Die URL lautet:
https://<Partner>-<Projekt>.dstore.de/xml/joblog
Pflichtparameter
- Jobname : Name des Jobs der abgerufen werden soll.
Rückmeldung
Die Rückmeldung aller im Erfolgsfall ist
- HTTP-Status 200 OK
- Body (application/xml) mit dem Logfile.
jobstatus
Liefert den Status zum angegebenen Job. Die URL lautet:
https://<Partner>-<Projekt>.dstore.de/xml/jobstatus
Die möglichen Rückmeldungen sind der folgenden Tabelle zu entnehmen:
| Rückmeldung | Bedeutung |
|---|---|
| joberrors | Die Überprüfung des Jobs schlug fehl und er befindet sich im Ordner für fehlerhafte Jobs. In diesem Fall gab es beim hochladen des Jobs einen HTTP-Status-Code ungleich 200 mit einer Fehlermeldung |
| queue/<Schnittstelle> | Der Job befindet sich in der Warteschleife der entsprechenden Schnittstelle. Verbleibt er dort länger als erwartet ist in dieser Schnittstelle die Verarbeitung angehalten oder es blockiert eine Datei aufgrund von Ressourcen-Limits die Schnittstelle |
| bak/<Schnitstelle> | Job ist verarbeitet und befindet sich im Sicherungsordner |
Pflichtparameter
- Jobname : Name des Jobs der abgerufen werden soll.
Rückmeldung
Die Rückmeldung aller Methoden im Erfolgsfall ist
- HTTP-Status 200 OK
- Body (text/plain) mit dem aktuellem „Status“ des Job (siehe oben).
Rückmeldung bei Fehlern
Ist es zu einem Fehler gekommen (Jobname falsch o.ä.) ist die Rückmeldung für alle Methoden:
- HTTP-Status ungleich 200, in der Regel ist das dann:
- Falls eine Änderung der Parameter den Fehler beheben kann: 400 Bad Request
- Falls der Request unverändert zu einem späteren Zeitpunkt erfolgreich sein kann: 503 Service Unavailable
- Falls http statt https verwendet wurde 403 Forbidden
- Body (text/plain) mit weiteren Informationen (i.d.R. sind dies die Fehlermeldungen)