hosting

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

One bulk job and its per-site report.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա sites.view թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը 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}