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 : Unauthorized
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 : Unauthorized
404 : NotFound
Pour annuler une tâche spécifique, utilisez le point de terminaison DELETE {baseURL}/v3/jobs/{jobId}. La tâche doit être à l'état « En file d'attente » ou « En cours d'exécution ».
Si vous annulez une tâche en cours d'exécution, elle est annulée. Si vous annulez une tâche en file d'attente, elle est supprimée.
Note
Les administrateurs peuvent annuler n'importe quelle tâche.
D'autres rôles peuvent annuler des tâches qu'ils ont créées, déclenchées ou planifiées. Cela inclut les tâches partagées avec eux par le biais de collections, même s'ils ne sont pas le propriétaire de la tâche.
jobId (chaîne) : obligatoire. Saisissez l'ID de tâche à supprimer.
curl -X 'DELETE' \
'http://localhost/webapi/v3/jobs/678f97baa15300008c0039fc' \
-H 'accept: application/json' \
-H 'authorization: Bearer BearerTokenGoesHere'200 : OK
Réponse lorsque vous annulez une tâche en cours d'exécution :
{ "message": "Cancelled Successfully." }Réponse lorsque vous annulez une tâche en file d'attente :
{ "message": "Deleted Successfully." }
400 : BadRequest
Réponse lorsque la tâche n'est pas à l'état « En file d'attente » ou « En cours d'exécution » :
{ "message": "This job is not in 'Queued' or 'Running' state." }Réponse lorsque l'utilisateur effectuant l'appel API n'est pas autorisé à annuler la tâche :
{ "message": "You do not have permission to cancel this job." }
401 : Unauthorized
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 Workflow Endpoints.
Pour en savoir plus sur les demandes Postman, consultez la page d'aide Comment utiliser Postman.