hosting

GET `/v1/bulk-jobs/{bulkJobId}`

One bulk job and its per-site report.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API key) كرمز حامل (bearer token). يجب أن يحمل المفتاح إذن sites.view؛ والمفتاح الذي لا يملكه يُرفض بالرمز 403 وليس 404.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X GET https://api.zinndigital.com/v1/bulk-jobs/{bulkJobId} \
  -H "Authorization: Bearer zdk_live_…"

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

⭐ The per-site rows are the feature. A job that reported only a count could not answer "which of my sites missed it, and why?", and a bulk action whose failures are invisible is worse than none, because it is believed. A cheap database read, polled while a job is in flight, so it never describes a workflow and never calls a hosting adapter. Requires sites.view.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`bulkJobId (path)`	`Uuid`	نعم	Bulk job ID (UUIDv7).

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	نعم	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`operation`	`BulkOperation`	نعم	What a bulk job does to each of its sites. ⛔ One job model with an operation discriminator, not eight job models. A selection, a frozen work-list, a durable pass and a per-site…
`params`	`BulkJobParams`	نعم	The operation's arguments. Which keys are read depends on `operation`: `plugin_install` takes `slugs` + `activate`; `plugin_activate`, `plugin_deactivate` and `plugin_remove` take…
`selector`	`BulkSelector`	نعم	Which sites a job targets. ⛔ There is no `all`. A job belongs to exactly one organization and `all` would span every tenant on the platform; the fleet-wide act is a staff…
`selector_value`	`string`	نعم	—
`status`	`BulkJobStatus`	نعم	⛔ `partial` is a real outcome, not a rounding of the other two. A job where 4 of 900 sites failed is neither a success nor a failure, and reporting it as either is how a bulk…
`requested_by`	`string`	نعم	Who asked for it.
`note`	`string`	نعم	—
`created_at`	`string`	نعم	—
`updated_at`	`string`	نعم	—
`settled_at`	`object`	نعم	When the job finished; `null` while it is still running.
`counts`	`BulkJobCounts`	نعم	—
`progress`	`BulkJobProgress`	نعم	How far along a job is, how fast it is going and how much longer it has. ⛔⛔ Every estimate here is nullable, and a `null` must never be rendered as `0`. `rate_per_minute: 0`…
`items`	`BulkJobItem[]`	نعم	—

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 429

GET /v1/bulk-jobs/{bulkJobId}