Betriebsstatus

API 0.16.0OpenAPIllms-full.txt

GET/v1/operations/{operation_id}

Gibt den aktuellen Status einer Operation anhand ihrer id. zurück. Während status gleich queued oder running ist, ist die Operation nicht abgeschlossen. Überprüfen Sie nach Abschluss result auf Erfolg oder error auf Fehler.

Berechtigungs- und Zugangsbereiche · Fehler und Wiederholungen

Anfrage

curl -X GET 'https://adapt-mail.com/v1/operations/<operation_id>' \
  -H 'Authorization: Bearer <access_token>'

Optionen

operation_idpathUnbedingt

string · uuid

X-Customer-IDheader

Option 1

string

Option 2

null

Antworten

200 Erfolgreiche Antwort

application/json

object

id

string · uuid

Vorgangs-ID zum Überprüfen des Status und Abbrechen einer ausstehenden Übermittlung.

kind

string

mailbox_id

Option 1

integer

Option 2

null

status

string

Gültige Werte: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

created_at

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

completed_at

Option 1

string

Datum und Uhrzeit in UTC. Wenn kein Offset vorhanden ist, stellt der Wert auch UTC. dar

Option 2

null

error

Der Grund für den Fehler, wenn der Vorgang nicht erfolgreich abgeschlossen wurde.

Option 1

string

Option 2

null

result

Das Ergebnis der Operation. Enthält zum Versenden Informationen über angenommene und abgelehnte Empfänger.

Option 1

object

Option 2

null

401 Anmeldung erforderlich

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

403 Kein Zugriff

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

404 Ressource nicht gefunden

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

409 Staatskonflikt

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object

422 Validierungsfehler

application/json

object

detail

array

Array-Elemente

object

locUnbedingt

array

Array-Elemente

Option 1

string

Option 2

integer

msgUnbedingt

string

typeUnbedingt

string

503 Vorübergehende Nichtverfügbarkeit

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Array-Elemente

object