hosting
GET /v1/bulk-jobs/{bulkJobId}
One bulk job and its per-site report.
Authentification
Envoyez une clé API en tant que jeton du porteur. La clé doit posséder l'autorisation sites.view ; une clé qui ne l'a pas est refusée avec le code 403, et non 404.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/bulk-jobs/{bulkJobId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
⭐ 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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
bulkJobId (path) | Uuid | Oui | Bulk job ID (UUIDv7). |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
org_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
operation | BulkOperation | Oui | 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 | Oui | 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 | Oui | 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 | Oui | — |
status | BulkJobStatus | Oui | ⛔ 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 | Oui | Who asked for it. |
note | string | Oui | — |
created_at | string | Oui | — |
updated_at | string | Oui | — |
settled_at | object | Oui | When the job finished; null while it is still running. |
counts | BulkJobCounts | Oui | — |
progress | BulkJobProgress | Oui | 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[] | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404 · 429