પ્રમાણીકરણ
એપીઆઈ કી (API key) ને બેરર ટોકન તરીકે મોકલો. કી પાસે sites.view પરવાનગી હોવી આવશ્યક છે; તેના વગરની કીને 404 ને બદલે 403 સાથે અસ્વીકાર કરવામાં આવશે.
આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.
આયમાવો
કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.
curl -X GET https://api.zinndigital.com/v1/bulk-jobs/{bulkJobId} \
-H "Authorization: Bearer zdk_live_…"साइन ઇન કરેલ છે? તમારા ડેશબોર્ડમાં આવેલું API કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ 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` ta… |
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 operat… |
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 ac… |
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