Obtenir une tâche.¶
Méthode¶
GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/{task_id}
Description¶
Obtient un objet de tâche à partir de son identifiant.
Interrogez l’état de la tâche à intervalles croissants de manière exponentielle pendant que vous attendez qu’elle se termine : Commencez à 15 secondes et doublez l’intervalle jusqu’à 4 minutes (15 s, 30 s, 60 s, 2 min, 4 min). Il est inutile d’interroger plus fréquemment : l’état mis en cache ne changera pas plus tôt et cette pratique augmente le risque d’erreurs HTTP 429 dues aux limites de débit.
Paramètres de chemin¶
|
tenant_id
string
obligatoire
Identifiant du locataire propriétaire de la tâche. |
|
task_id
string
obligatoire
Identifiant de la tâche à obtenir. |
curl -X GET \
-H 'Authorization: {api-key}' \
https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/{task_id}
Schéma de la réponse réussie (200)¶
|
object
Task décrit une tâche unique. |
|
id
string
Identifiant de la tâche. |
|
resource_id
string
Identifiant de la ressource à laquelle la tâche est associée. |
|
status
string
État de la tâche. Valeurs valides : `open`, `inprogress`, `done`, `failed`, `suspended`, `warnings`, `canceled`. Les états `done`, `failed`, `warnings` et `canceled` sont définitifs. L’état `warnings` indique que la tâche s’est terminée avec des avertissements susceptibles de nécessiter votre attention. |