Details zu einem bestimmten Auftrag abrufen
Nachrichten eines bestimmten Auftrags abrufen
Einen bestimmten Auftrag abbrechen
Weitere Informationen zu Objektbeziehungen und deren Verwendung in der API finden Sie im Abschnitt Objektbeziehungen.
Weitere Informationen zu Aufträgen finden Sie auf der Hilfeseite Aufträge: Admin-Oberfläche.
Um Details zu einem vorhandenen Auftrag und seinem aktuellen Status abzurufen, verwenden Sie Endpunkt GET {baseURL}/v3/jobs/{jobId}. Verwenden Sie verschiedene Parameter, um die anzuzeigenden Aufträge zu filtern.
Anmerkung
Es können nur App-Workflows verwendet werden.
Benutzer:innen können Aufträge anzeigen, die von ihnen ausgeführt werden, sowie Aufträge, die nach Zeitplänen ausgeführt werden, die über Sammlungen freigegeben wurden.
jobId (Zeichenfolge): erforderlich. Geben Sie die Auftrags-ID ein, für die Sie Details anzeigen möchten.
includeMessages (boolescher Wert): optional. Kann ohne Wert belassen werden. Sie können aus den folgenden Werten wählen: „true“ und „false“. Wenn dieser Parameter auf „false“ gesetzt ist, wird ein reduziertes Objekt zurückgegeben. Wenn keine Angabe gemacht wird, wird der Wert „true“ verwendet.
curl -X 'GET' \
'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
{ "id": "string", "appId": "string", "createDateTime": "2024-09-19T10:02:54.589Z", "status": "string", "disposition": "string", "outputs": [ { "id": "string", "availableFormats": [ "string" ], "fileName": "string" } ], "messages": [ { "status": 0, "text": "string", "toolId": 0 } ], "priority": "Default", "workerTag": "string", "runWithE2": true }401: Keine Berechtigung
404: Nicht gefunden
Um Nachrichten eines bestimmten Auftrags abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/jobs/{jobId}.
Anmerkung
Nur Administrator:innen können diesen Endpunkt verwenden.
jobId (Zeichenfolge): erforderlich. Geben Sie die Auftrags-ID ein, für die Sie Nachrichten anzeigen möchten.
curl -X 'GET' \
'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
{ "status": 0, "text": "string", "toolId": 0 }401: Keine Berechtigung
404: Nicht gefunden
Um einen bestimmten Auftrag abzubrechen, verwenden Sie den Endpunkt DELETE {baseURL}/v3/jobs/{jobId}. Der Auftrag muss sich im Status „In Warteschlange“ oder „Wird ausgeführt“ befinden.
Wenn Sie einen laufenden Auftrag abbrechen, wird er abgebrochen. Wenn Sie einen Auftrag in der Warteschlange abbrechen, wird er gelöscht.
Anmerkung
Administratoren können jeden Auftrag abbrechen. Andere Rollen können nur Aufträge abbrechen, die sie selbst erstellt, ausgelöst oder geplant haben.
Andere Rollen können Aufträge, die sie erstellt, ausgelöst oder geplant haben, abbrechen. Dies umfasst für sie über Sammlungen freigegebene Aufträge, auch wenn sie nicht Auftragsbesitzer:innen sind.
jobId (Zeichenfolge): erforderlich. Geben Sie die Auftrags-ID ein, die Sie löschen möchten.
curl -X 'DELETE' \
'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200: OK
Antwort beim Abbrechen eines laufenden Auftrags:
{ "message": "Cancelled Successfully." }Antwort beim Abbrechen eines Auftrags in der Warteschlange:
{ "message": "Deleted Successfully." }
400: Fehlerhafte Anfrage
Antwort, wenn sich der Auftrag nicht im Status „In Warteschlange“ oder „In Ausführung“ befindet:
{ "message": "This job is not in 'Queued' or 'Running' state." }Antwort, wenn der Benutzer, der den API-Aufruf stellt, keine Berechtigung zum Abbrechen des Auftrags hat:
{ "message": "You do not have permission to cancel this job." }
401: Keine Berechtigung
404: Nicht gefunden
Wenn Sie Informationen zu einem bestimmten Auftrag abrufen möchten, benötigen Sie eine jobId. Um diese jobId abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/workflows/{workflowId}/jobs. Weitere Informationen über diesen Endpunkt finden Sie auf der Hilfeseite Workflow-Endpunkte.
Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden.