परिचालन स्थिति

API 0.16.0OpenAPIllms-full.txt

GET/v1/operations/{operation_id}

किसी ऑपरेशन की वर्तमान स्थिति को उसके id. द्वारा लौटाता है जबकि status queued या running के बराबर है, ऑपरेशन पूरा नहीं हुआ है। एक बार पूरा होने पर, सफलता पर result या त्रुटि पर error जांचें।

प्राधिकरण और पहुंच क्षेत्र · त्रुटियाँ और दोहराव

अनुरोध

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

विकल्प

operation_idpathअनिवार्य रूप से

string · uuid

X-Customer-IDheader

विकल्प 1

string

विकल्प 2

null

प्रतिक्रियाएँ

200 सफल प्रतिक्रिया

application/json

object

id

string · uuid

स्थिति की जांच करने और लंबित सबमिशन को रद्द करने के लिए ऑपरेशन आईडी।

kind

string

mailbox_id

विकल्प 1

integer

विकल्प 2

null

status

string

मान्य मान: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

created_at

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

completed_at

विकल्प 1

string

UTC. में दिनांक और समय यदि कोई ऑफसेट नहीं है, तो मान UTC. का भी प्रतिनिधित्व करता है

विकल्प 2

null

error

यदि ऑपरेशन सफलतापूर्वक पूरा नहीं हुआ तो त्रुटि का कारण।

विकल्प 1

string

विकल्प 2

null

result

ऑपरेशन का नतीजा. भेजने के लिए, स्वीकृत और अस्वीकृत प्राप्तकर्ताओं के बारे में जानकारी शामिल है।

विकल्प 1

object

विकल्प 2

null

401 लॉगिन आवश्यक है

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

403 तक पहुँच नहीं

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

404 संसाधन नहीं मिला

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

409 राज्य संघर्ष

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object

422 सत्यापन त्रुटि

application/json

object

detail

array

सरणी तत्व

object

locअनिवार्य रूप से

array

सरणी तत्व

विकल्प 1

string

विकल्प 2

integer

msgअनिवार्य रूप से

string

typeअनिवार्य रूप से

string

503 अस्थायी अनुपलब्धता

application/json

object

detail

विकल्प 1

string

विकल्प 2

object

code

string

message

string

विकल्प 3

array

सरणी तत्व

object