Klineo/Docs
Open app ↗

API schemas

ProtectedExecutionPlan

All API schemas

object — Additional properties rejected

Field Required at this level Type Description and constraints
planId Yes string —
quoteRequestId Yes string —
quoteSetResourceVersion Yes Hash —
quoteSetArtifactHash Yes Hash —
autonomyPolicyId Yes string —
autonomyPolicyResourceVersion Yes Hash —
autonomyPolicyArtifactHash Yes Hash —
controlEpoch Yes AtomicAmount —
publicMempoolFallbackAllowed Yes boolean —
executionClass Yes string Allowed: PREVIEW_ONLY, CONTROLLER_TYPED_EXECUTABLE
executionUnavailableReasons Yes Array of string —
status Yes string Allowed: PREPARED, IN_PROGRESS, COMPLETED, PAUSED, FAILED_CLOSED
selectedQuote No ProtectedExecutionQuote —
netAmountOutQuote Yes AtomicAmount —
childLegs Yes Array of object —
childLegs[].childLegId Yes string —
childLegs[].index Yes integer Minimum: 0
childLegs[].amountIn Yes PositiveAtomicAmount —
childLegs[].minimumAmountOut Yes PositiveAtomicAmount —
childLegs[].expiresAt Yes string Format: date-time
childLegs[].state Yes string Allowed: PREPARED, SUBMITTED, FINALIZED_RECONCILED, PAUSED, FAILED
childLegs[].typedAction Yes ProtectedExecutionTypedAction —
childLegs[].typedActionHash No Hash —
childLegs[].submissionEvidenceHash No Hash —
childLegs[].transactionHash No Hash —
childLegs[].finalityEvidenceHash No Hash —
childLegs[].reconciliationEvidenceHash No Hash —
childLegs[].failureEvidenceHash No Hash —
childLegs[].executionReceipt No ProtectedExecutionTransactionReceiptV2 —
childLegs[].consumedAmountIn No AtomicAmount —
childLegs[].residualAmountIn No AtomicAmount —
childLegs[].amountOutReceived No AtomicAmount —
transitions Yes Array of ProtectedExecutionLegTransition —
totalInputAmount Yes AtomicAmount —
totalConsumedAmount Yes AtomicAmount —
totalResidualAmount Yes AtomicAmount —
totalUnresolvedAmount Yes AtomicAmount —
totalAmountOutReceived Yes AtomicAmount —
fallbackQuoteId No string —
requiresSafeApproval Yes boolean —
pauseReason No string Allowed: PRIVATE_EXECUTION_UNAVAILABLE, QUOTE_EXPIRED, POLICY_CHANGED

Nested required fields apply when their parent object or matching union branch is present. Named types link to their complete schema.

Exact definition: #/components/schemas/ProtectedExecutionPlan in the OpenAPI contract.