Auftragsendpunkte

Auftragsendpunkte und Parameter

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.

Details zu allen Aufträgen abrufen

Um Details zu allen Aufträgen und ihrem aktuellen Status abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/jobs/. Verwenden Sie verschiedene Parameter, um die anzuzeigenden Aufträge zu filtern.

Anmerkung

Nur Administrator:innen können diesen Endpunkt verwenden.

Parameter

sortField (Zeichenfolge): Optional. Sortieren Sie die Ergebnisse nach folgenden zulässigen Werten: CreateDate, AppName, CompletionDateTime, Priority, Status.
direction (Zeichenfolge): Optional. Sortieren Sie in aufsteigender oder absteigender Reihenfolge. Zulässige Werte sind: asc oder desc.
offset (Zeichenfolge): Optional. Geben Sie einen Offset für die Paginierung ein.
limit (Zeichenfolge): Optional. Geben Sie einen Grenzwert für die Paginierung ein.
priorities (Zeichenfolge): Optional. Um nach Auftragsprioritäten zu filtern, geben Sie einen oder mehrere der folgenden Werte ein: Low (Niedrig), Medium (Mittel), High (Hoch), Critical (Kritisch) und Numeric Values (Numerische Werte).
statuses (Zeichenfolge): Optional. Um nach Status zu filtern, geben Sie einen oder mehrere der folgenden Werte ein: Queued (In Warteschlange), Initializing (Wird initialisiert), Running (Wird ausgeführt) und Complete (Beendet).
users (Zeichenfolge): Optional. Um nach einem/einer Benutzer:in zu filtern, geben Sie eine gültige userID ein. Filtert nur, wenn allUsers = true.
allUsers (boolescher Wert): Optional. Um alle Benutzer:innen einzuschließen, wählen Sie true.
workflowNames (Zeichenfolge): Optional. Um nach einem Workflownamen zu filtern, geben Sie einen oder mehrere workflowName ein.
completedBefore (Zeichenfolge): Optional. Gibt Aufträge zurück, die vor dem angegebenen Datum abgeschlossen wurden. Aufträge, die am angegebenen Datum abgeschlossen wurden, sind ausgeschlossen. Das erforderliche Format ist JJJJ-MM-TT.
completedAfter (Zeichenfolge): Optional. Gibt Aufträge zurück, die nach dem angegebenen Datum abgeschlossen wurden. Aufträge, die am angegebenen Datum abgeschlossen wurden, sind ausgeschlossen. Das erforderliche Format ist JJJJ-MM-TT.

Anforderungsbeispiel: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Antwortbeispiel

200: OK

{
  "data": [
    {
      "jobId": "68dd3292c97fddfcc003adcb",
      "status": "Completed",
      "workflowName": "Workflow1.yxmd",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:54:26Z",
      "queueTime": "2025-10-01T13:54:26Z",
      "executionTime": "00:00:02",
      "priority": "6"
    },
    {
      "jobId": "68dd3336c97fddfcc003add2",
      "status": "Completed",
      "workflowName": "Workflow1",
      "workflowId": "68dd32922a719467662d27c7",
      "submittedBy": "Jane Doe",
      "startTime": "2025-10-01T13:57:10Z",
      "queueTime": "2025-10-01T13:57:10Z",
      "executionTime": "00:00:02",
      "priority": "Low"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 50,
    "totalItems": 3,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPreviousPage": false
  }
}

401: Keine Berechtigung

Details zu einem bestimmten Auftrag abrufen

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.

Parameter

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.

Anforderungsbeispiel: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c?includeMessages=true' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Antwortbeispiel

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

Nachrichten eines bestimmten Auftrags abrufen

Um Nachrichten eines bestimmten Auftrags abzurufen, verwenden Sie den Endpunkt GET {baseURL}/v3/jobs/{jobId}.

Anmerkung

Nur Administrator:innen können diesen Endpunkt verwenden.

Parameter

jobId (Zeichenfolge): erforderlich. Geben Sie die Auftrags-ID ein, für die Sie Nachrichten anzeigen möchten.

Anforderungsbeispiel: cURL

curl -X 'GET' \
  'http://localhost/webapi/v3/jobs/66ebd18d3d6200007e000d8c/messages' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Antwortbeispiel

200: OK

{
  "status": 0,
  "text": "string",
  "toolId": 0
}

401: Keine Berechtigung
404: Nicht gefunden

Einen bestimmten Auftrag abbrechen

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 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.

Parameter

jobId (Zeichenfolge): erforderlich. Geben Sie die Auftrags-ID ein, die Sie löschen möchten.

Anforderungsbeispiel: cURL

curl -X 'DELETE' \
  'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer BearerTokenGoesHere'

Antwortbeispiel

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

Objektbeziehungen

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.Workflow-Endpunkte

Postman-Anforderungen

Weitere Informationen zu Postman-Anforderungen finden Sie auf der Hilfeseite Postman verwenden.

In diesem Abschnitt:

Auftragsendpunkte