hosting

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

One bulk job and its per-site report.

تصدیق‌هویت

یو API کی د بیئرر ټوکن (bearer token) په توګه ولیکئ. کی باید د sites.view اجازه ولري؛ له دې اجازې پرته کی د 404 پرځای د 403 په واسطه رد کیږي.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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

ننوتي یاست؟ ستاسو په ډشبورډ کې د API کنسول ستاسو د اصلي سازمان ID او ستاسو خپله کیلي ډکوي، او غوښتنه د ژوندی API په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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}