hosting
POST /v1/bulk-jobs/{bulkJobId}/retry-failed
Run a bulk job's failures again.
認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X POST https://api.zinndigital.com/v1/bulk-jobs/{bulkJobId}/retry-failed \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Puts the failed and skipped items back to pending and restarts the job's workflow. ⭐ unsupported items are not reopened, and that is deliberate: a platform with no shell will not grow one because somebody pressed a button, so a retry that provably does nothing is how a control stops being believed. A job that is still running is a 409 — the restart reuses the job's own workflow id, so this cannot start a second pass over the same rows. A job with nothing left to retry is a 422. Requires sites.view plus the operation's own key.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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… |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429