Récupérer les détails d'une tâche spécifique
Récupérer les messages d'une tâche spécifique
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.
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.
Les utilisateurs peuvent voir les tâches exécutées par eux et les tâches exécutées selon des planifications partagées via Collections.
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.
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 : Non autorisé
404 : NotFound
Pour extraire tous les messages d'une tâche spécifique, utilisez le point de terminaison GET {baseURL}/v3/jobs/{jobId}/messages
.
Note
Seuls les Administrateurs peuvent utiliser ce point de terminaison.
jobId (chaîne) : obligatoire. Saisissez l'ID de tâche pour lequel vous souhaitez afficher les messages.
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 : Non autorisé
404 : NotFound
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 du workflow.
Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman.