Async
speccustomimplproposalDieser Hilfsbaustein stellt anderen Bausteinen Operationen für asynchrone Jobs bereit. Er kann nicht konfiguriert werden und wird bei Bedarf automatisch aktiviert.
Umfang
Operationen
| Ressource | Pfad | Methoden | Formate | Beschreibung |
|---|---|---|---|---|
Job Status | jobs/{jobId} | GET | HTML, JSON | Gibt die Statusinformationen eines bestimmten Jobs zurück. |
Dismiss Job | jobs/{jobId} | DELETE | HTML, JSON | Einen Job verwerfen. Wenn sich der Job aktuell im Zustand "accepted" oder "running" befindet, wird er abgebrochen. Danach werden der Job und seine Ergebnisse entfernt. Die Antwort sind die Statusinformationen des verworfenen Jobs. |
Results (full) | jobs/{jobId}/results | GET | Any, JSON | Alle angeforderten Job-Ergebnisse abrufen. Ist das Ergebnis des Jobs ein einzelnes Dokument, z. B. das Ergebnis einer Suche oder einer Transaktion, wird es in dem Medientyp geliefert, in dem es gespeichert ist, unabhängig vom Accept-Header; der Parameter f wird nicht unterstützt. |
Results (specific) | jobs/{jobId}/results/{outputId} | GET | JSON | Ein bestimmtes der angeforderten Job-Ergebnisse abrufen |
Results (index) | jobs/{jobId}/results/{outputId}/{N} | GET | JSON | Den N-ten Wert eines bestimmten mehrwertigen Job-Ergebnisses abrufen |
Pfad-Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
jobId | jobs/{jobId}, jobs/{jobId}/results, jobs/{jobId}/results/{outputId}, jobs/{jobId}/results/{outputId}/{N} | Der lokale Identifikator eines Jobs, eindeutig innerhalb der API. |
outputId | jobs/{jobId}/results/{outputId}, jobs/{jobId}/results/{outputId}/{N} | Der Bezeichner eines bestimmten Ergebnisses eines Jobs. Für Prozesse lassen sich diese im Abschnitt outputs der Beschreibung des ausgeführten Prozesses entnehmen. |
Index N | jobs/{jobId}/results/{outputId}/{N} | Der nullbasierte Index für den Zugriff auf einen Wert eines mehrwertigen Ergebnisses. |
Query Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
f | jobs/{jobId} | Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP-Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet. |
outputs | jobs/{jobId}/results | Die Ausgaben des Prozesses, die in die Ergebnisse aufgenommen werden sollen. Der Parameterwert ist eine durch Kommata getrennte Liste von Identifikatoren der Ausgaben. Standardmäßig sind alle Ausgaben enthalten, die im Ausführungsrequest angefordert wurden. Der Parameter gilt nicht für einen Job, dessen Ergebnis ein einzelnes Dokument ist, z. B. das Ergebnis einer Suche oder einer Transaktion. |
Konfiguration
Dieses Modul hat keine Konfigurationsoptionen.
Dieses Modul benötigt bzw. unterstützt keine zusätzlichen Konfigurationsdateien.