Preview a bulk operation

Prepares one bounded frozen selection for retry, cancel, reschedule, pause or resume. Requires the selected action's ordinary scopes and execution reads for parent mapping. Preview creates no deliveries, lifecycle mutations or billable attempts. Only complete awaiting_confirmation jobs may be confirmed.

post/v1/bulk/jobs

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/bulk/jobs
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Request body

OR
OR
OR
OR

Response

Preview a bulk operation

idstring required
state'preparing' | 'awaiting_confirmation' | 'queued' | 'running' | 'paused' | 'blocked' | 'completed' | 'completed_with_failures' | 'cancelled' | 'expired' | 'refused' required
versioninteger required
createdAtstring required
updatedAtstring required
referenceAtstring required
preparationExpiresAtstring required
previewExpiresAtstring
executionExpiresAtstring
resultsExpireAtstring
intentDigeststring
completeboolean required
warningsstring[] required
reason'eligible' | 'already_active' | 'already_paused' | 'already_cancelled' | 'invalid_state' | 'unsupported_target' | 'expired_input' | 'unauthorized' | 'concurrently_changed' | 'past_time' | 'attempt_limit' | 'operation_failed' | 'transient_failure' | 'selection_too_large' | 'preparation_incomplete' | 'preview_expired' | 'job_expired' | 'job_cancelled' | 'quota_exceeded' | 'spending_limit' | 'in_flight'

Changes

No recorded changes to this operation across all 1 revision of this API.