Server-Antwort auf den POST Request
In diesem Abschnitt werden folgende Schritte beschrieben:
•Übersicht über mögliche Server-Antworten
•Antwort: Request fehlgeschlagen, keine Antwort vom Server
•Antwort: Der Request wurde übertragen, doch der Auftrag wurde vom Server abgewiesen
•Antwort: Der Auftrag wurde ausgeführt (mit positivem oder negativem Ergebnis)
Wenn ein POST Request erfolgreich an den Server bereitgestellt wurde, wird der Auftrag in die Server-Warteschlange platziert. Der Server gibt eine 201 Created Meldung und eine Ergebnisdokument-URI zurück. Der Auftrag wird zum frühestmöglichen Zeitpunkt verarbeitet. Falls in der Zwischenzeit das Ergebnisdokument angefordert wird, wird eine Meldung "status": "Running" zurückgegeben, wenn der Auftrag gestartet, aber noch nicht fertig gestellt wurde; der Client sollte das Dokument zu einem späteren Zeitpunkt wieder anfordern. Mit dem Status Dispatched wird angegeben, dass sich der Auftrag in der Server-Warteschlange befindet, aber noch nicht gestartet wurde.
Das Ergebnis des Auftrags (z.B. einer Validierungsanforderung) kann negativ (Validierung fehlgeschlagen) oder positiv (Validierung erfolgreich) sein. In beiden Fällen wird eine 201 Created Meldung zurückgegeben und ein Ergebnisdokument wird generiert. Es kann auch sein, dass der POST Request nicht an den Server übertragen wurde (Request fehlgeschlagen) oder der Request zwar übertragen wurde, der Auftrag vom Server aber abgewiesen wurde (Request übertragen, doch Auftrag abgewiesen). Im nachstehenden Diagramm sind die verschiedenen möglichen Ergebnisse dargestellt.
Request fehlgeschlagen, keine Antwort vom Server
Wenn Requests nicht erfolgreich an den Server übertragen werden können, sind die häufigsten Fehler die folgenden:
Meldung | Erklärung |
404 Not Found | Der richtige Pfad lautet:http://localhost:8087/v1/queue/ |
405 Method Not Allowed | Die angegebene Methode ist für diese Ressource unzulässig. Verwenden Sie die POST Methode. |
415 Unsupported Media Type | Der Message Header sollte lauten: Content-Type:application/json. |
Request übertragen, doch der Auftrag wurde vom Server abgewiesen
Wenn Requests erfolgreich an den Server übertragen wurden, kann der Server diese aus einem der folgenden Gründe abweisen:
Message | Erklärung |
400 Bad Request (bad cmd) | Der RaptorXML Befehl ist falsch. |
400 Bad Request (json error) | Der Request Body enthält einen JSON-Syntaxfehler. |
404 File Not Found | Überprüfen Sie die Datei-URI (oder die Dateipfad)-Syntax aller im Befehl genannten Dateien. |
Der Auftrag wurde ausgeführt (mit positivem oder negativem Ergebnis)
Wenn ein Auftrag (z.B. ein Validierungsauftrag) ausgeführt wird, kann das Ergebnis positiv (OK) oder negativ (fehlgeschlagen) sein. So kann z.B. das Ergebnis eines Validierungsauftrags positiv (OK) sein, wenn das zu validierende Dokument gültig ist und negativ (fehlgeschlagen), wenn das Dokument ungültig ist.
In beiden Fällen wurde der Auftrag ausgeführt, allerdings mit unterschiedlichen Ergebnissen. In beiden Fällen wird eine 201 Created Meldung zurückgegeben, sobald der Auftrag erfolgreich in die Warteschlange aufgenommen wurde. In beiden Fällen wird auch eine Ergebnisdokument-URI an den HTTP-Client, von dem der Request stammt, zurückgegeben. Nachdem das Ergebnisdokument erstellt wurde, kann es mit einem HTTP GET Request abgerufen werden.
Möglicherweise wurde das Ergebnisdokument noch nicht erstellt, wenn mit der Verarbeitung des Auftrags noch nicht begonnen oder der Auftrag noch nicht fertig verarbeitet wurde. Während das Ergebnisdokument während dieser Zeit angefordert wird, wird eine "status": "Running" Meldung zurückgegeben, wenn der Auftrag gestartet, aber noch nicht fertig gestellt wurde; mit dem Status Dispatched wird angegeben, dass sich der Auftrag in der Server-Warteschlange befindet, aber noch nicht gestartet wurde.
Zusätzlich zum Ergebnisdokument können auch andere Dokumente generiert werden. Dazu gehören die folgenden:
•Auftrag wurde mit dem Ergebnis 'Fehlgeschlagen' ausgeführt: Ein Fehlerprotokoll wird in drei Formaten erstellt: Text, langes XML-Dokument und kurzes XML-Dokument. Die URIs dieser drei Dokumente werden im Ergebnisdokument (welches im JSON-Format ist) gesendet. Die URIs können in einem HTTP GET Request verwendet werden, um die Fehlerdokumente abzurufen.
•Auftrag wurde mit dem Ergebnis 'OK' ausgeführt: Der Auftrag wird erfolgreich ausgeführt und die Ausgabedokumente - wie z.B. die durch eine XSLT-Transformation erzeugte Ausgabe - werden erstellt. Wenn Ausgabedateien generiert wurden, werden ihre URIs im Ergebnisdokument, das im JSON-Format ist, gesendet. Die URIs können anschließend in einem HTTP GET Request verwendet werden, um die Ausgabedokumente abzurufen. Beachten Sie, dass nicht alle Aufträge Ausgabedateien haben; ein Beispiel dafür ist ein Validierungsauftrag. Außerdem kann es vorkommen, dass ein Auftrag mit dem Status 'OK' fertig gestellt wurde, dass es aber Warnungen und/oder andere Meldungen gab, die in Fehlerdateien geschrieben wurden. In diesem Fall werden die URIs der Fehlerdateien (zusätzlich zu den Ausgabedokumenten) ebenfalls im Ergebnisdokument gesendet.
Eine Beschreibung dieser Dokumente und wie Sie diese aufrufen, finden Sie unter Abrufen des Ergebnisdokuments und Abrufen von Fehler-/Ausgabedokumenten.