Obtenir une tâche.¶

Méthode¶

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/{task_id}

Description¶

Obtient une tâche à partir de son identifiant.

En attendant la fin de la tâche, consultez son état à des intervalles croissants de manière exponentielle : commencez par 15 secondes, puis doublez l’intervalle jusqu’à 4 minutes (15 s, 30 s, 60 s, 2 min, 4 min). Il est inutile de consulter l’état plus souvent : la valeur mise en cache ne sera pas actualisée plus rapidement, et des requêtes supplémentaires augmentent le risque d’erreurs HTTP 429 dues à la limitation du débit.

Paramètres de chemin¶

tenant_id string obligatoire

Identifiant du locataire auquel la tâche est rattachée.

task_id string obligatoire

Identifiant de la tâche demandée.

curl

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 en cas de succès (200)¶

object

Task décrit une tâche.

id string

Identifiant de la tâche.

resource_id string

Identifiant de la ressource associée à la tâche.

status string

État de la tâche. Valeurs valides : open, inprogress, done, failed, suspended, warnings, canceled. Les états done, failed, warnings et canceled sont des états terminaux. L’état warnings indique que la tâche s’est terminée avec des avertissements qui peuvent nécessiter votre attention.

Exemple de réponse¶

{
  "id": "string",
  "resource_id": "string",
  "status": "string"
}