Skip to main content

Points de terminaison des tâches

Points de terminaison et paramètres de tâches

Récupérer les détails d'une tâche spécifique

Retrieve Messages of a Specific Job

Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets .

Pour plus d'informations sur les tâches, consultez la page d'aide Tâches : interface Administrateur .

Récupérer les détails d'une tâche spécifique

Pour récupérer des détails sur une tâche existante et son état actuel, utilisez le point de terminaison GET {baseURL}/v3/jobs/{jobId} . Utilisez différents paramètres pour filtrer les tâches que vous souhaitez afficher.

Note

Seuls les workflows d'application peuvent être utilisés.

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

Paramètres

  • jobId (chaîne) : obligatoire. Saisissez l'ID de tâche pour lequel vous souhaitez afficher les détails.

  • includeMessages (booléen) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « vrai » et « faux ». Si ce paramètre est défini sur « faux », un objet réduit est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « vrai » est utilisée.

Exemple de demande : 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.

Note

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

Relations d'objets

Si vous souhaitez obtenir des informations sur une tâche spécifique, vous aurez besoin d'un jobId . Pour obtenir ce jobId, utilisez le point de terminaison GET {baseURL}/v3/workflows/{workflowId}/jobs . Pour plus d'informations sur ce point de terminaison, consultez la page d'aide Points de terminaison de workflow .Points de terminaison du workflow

Demandes Postman

Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman .

Dans cette section​: