Eine Aufgabe abrufen.¶

Methode¶

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

Beschreibung¶

Ruft eine Aufgabe anhand ihrer ID ab.

Fragen Sie den Aufgabenstatus bis zum Abschluss in exponentiell wachsenden Abständen ab: Beginnen Sie mit 15 Sekunden und verdoppeln Sie den Abstand bis auf 4 Minuten (15 s, 30 s, 60 s, 2 min, 4 min). Häufigere Abfragen sind nicht nötig: Der zwischengespeicherte Status ändert sich nicht früher. Sie erhöhen damit wegen der Anforderungsdrosselung die Wahrscheinlichkeit von Fehlern mit dem HTTP-Statuscode 429.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dem die Aufgabe zugeordnet ist.

task_id string erforderlich

ID der abzurufenden Aufgabe.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/tasks/{task_id}

Schema der erfolgreichen Antwort (200)¶

object

Task beschreibt eine einzelne Aufgabe.

id string

ID der Aufgabe.

resource_id string

ID der mit der Aufgabe verknüpften Ressource.

status string

Status der Aufgabe. Gültige Werte: open, inprogress, done, failed, suspended, warnings, canceled. Die Status done, failed, warnings und canceled sind Endzustände. Der Status warnings bedeutet, dass die Aufgabe mit Warnungen abgeschlossen wurde, die möglicherweise beachtet werden müssen.

Antwortbeispiel¶

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