hosting

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

One bulk job and its per-site report.

Gbogbo àwọn ìwé àṣẹ olùgbékalẹ̀ àgbékalẹ̀ →

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda sites.view; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ojú abánisọ̀rọ̀ yìí kò gba id ajọ kankan. Kọ́kọ́rọ́ rẹ ti mọ ajọ ti o jẹ ti e, a o si fèsì nipa rẹ̀.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

⭐ 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.

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`bulkJobId (path)`	`Uuid`	Bẹẹni	Bulk job ID (UUIDv7).

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`org_id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`operation`	`BulkOperation`	Bẹẹni	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`	Bẹẹni	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`	Bẹẹni	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`	Bẹẹni	—
`status`	`BulkJobStatus`	Bẹẹni	⛔ `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`	Bẹẹni	Who asked for it.
`note`	`string`	Bẹẹni	—
`created_at`	`string`	Bẹẹni	—
`updated_at`	`string`	Bẹẹni	—
`settled_at`	`object`	Bẹẹni	When the job finished; `null` while it is still running.
`counts`	`BulkJobCounts`	Bẹẹni	—
`progress`	`BulkJobProgress`	Bẹẹni	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[]`	Bẹẹni	—

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 404 · 429

GET /v1/bulk-jobs/{bulkJobId}