Zum Inhalt

Eine Aufgabe abrufen.

Methode

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

Beschreibung

Ruft ein Aufgabenobjekt anhand seiner ID ab.

Fragen Sie den Aufgabenstatus während der Wartezeit 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 erforderlich; der zwischengespeicherte Status ändert sich nicht früher. Zudem steigt dadurch aufgrund der Ratenbegrenzung die Wahrscheinlichkeit von HTTP-429-Fehlern.

Pfadparameter
tenant_id string erforderlich

Mandanten-ID des Aufgabeneigentümers.

task_id string erforderlich

ID der abzurufenden Aufgabe.

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

Aufgaben-ID.

resource_id string

ID der mit der Aufgabe verknüpften Ressource.

status string

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

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