Auftragsendpunkte

Auftragsendpunkte und Parameter

Details zu einem bestimmten Auftrag abrufen

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

Users are able to see jobs run by them and jobs run on schedules shared via Collections.

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'

Response Example

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: Unauthorized
404: NotFound

Retrieve Messages of a Specific Job

To retrieve all messages of a specific job, use the GET {baseURL}/v3/jobs/{jobId}/messages endpoint.

Anmerkung

Only Curators can use this endpoint.

Parameters

jobId (string): Required. Enter the Job ID for which you want to display messages.

Request Example: cURL

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

Response Example

200: OK

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

401: Unauthorized
404: NotFound

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