Document apiReferenceMutations

plan.execute

Execute a compiled batch of plan-safe operation entries with per-entry transactions, capture resolution between entries, and keep-prefix-and-continue failure semantics.

mutates documentnon-idempotent
doc.plan.execute(…)

Expected result

Returns a PlanExecuteResult with per-entry receipts, projected captures, and the first hard failure if any.

Inputs

entriesobject[]required
1 additional input field
captureReturns"*" | string[]
Variant 1

No fields.

Variant 2

No fields.

Result

Output fields
receiptsobject[]required
capturesobjectrequired
failureobject
Fields
entryIndexintegerrequired
operationIdstringrequired
messagestringrequired

Failures

Pre-apply throws

  • INVALID_INPUT
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas