Achtung

Die Beschreibung dieser Methode dient nur zu Dokumentationszwecken. Methoden die Jobs erzeugen liefern Ihnen ein Antwortdokument mit der vollständigen URL zur Abfrage des Jobstatus. Erzeugen Sie Anfrage-URLs zur Abfrage eines Jobstatus daher nicht manuell.

Beschreibung

Mit dieser Methode können Sie den Status eines Jobs für asynchrone Verarbeitung erfragen

Anfrage

Syntax

GET /v2/job/{JOBID} HTTP/1.1
Host: api.cobai.com
Content-Length: Länge
Date: Datum/Uhrzeit
Authorization: Signatur

Request-Parameter

Diese Methode benutzt keine zusätzlichen Request-Parameter

Request-Header

Diese Methode benutzt zusätzlich zu den Standard-Requestheadern keine weiteren Header.

Request-Body

Diese Methode verwendet keinen Request-Body

Antwort

Als Antwort erhalten Sie ein XML-Dokument mit den Statusinformationen des angefragten Jobs. Wurde mit Ihrem API-Schlüssel kein Job mit der angefragten Id erzeugt oder liegt die Erzeugung zu lange zurück erhalten Sie einen 404 Not Found-Status.

<job xmlns:atom="http://www.w3.org/2005/atom">
  <jobid>12345</jobid>
  <state>pending</state>
  <atom:link href="http://api.cobai.com/v1/job/12345" rel="self"/>
  <message xml:lang="de">Ihre Anfrage wartet auf die Verarbeitung.</message>
  <queuepos>5</queuepos>
</job>

Antwortelemente

Name Inhalt
jobid Die Id des Jobs. Dies ist die selbe Id die Sie in Ihrer Anfrage übergeben haben.
queuepos Die Jobs werden in eine Warteschlange eingereiht und in der Reihenfolge der Einreihung abgearbeitet. Ein Job an Position 1 wird verarbeitet. Sein Status wechselt dabei von pending auf running. Höhere Werte für queuepos bedeuten längere Wartezeit.
state pending: der Job wartet auf seine Ausführung
running: der Job wird gerade ausgeführt
done: der Job hat seine Ausführung beendet
done_with_error: Der Job wurde beendet, bei der Ausführung ist es aber zu mindestens einem Fehler gekommen.