VocalDocscontracts 1.65.0

PolicyEvaluateResult

The result of a dry run of one Policy (1.47.0, FR-orchestration-8).

An object with 16 fields.

Fields

FieldTypeRequiredDescription
actionPolicyAction or nullyesThe matched action with its parameters; null when not matched, and when it applies by failing closed.
action_typePolicyActionTypeyes
appliesbooleanyesWhether the action applies after orchestration-layer.md 3.9: when matched, or when a compliance-tagged Policy fails closed.
causePolicyOutcomeCause or nullyesWhy the outcome is error or timeout; null otherwise.
compliance_tagComplianceTag or nullyes
elapsed_usnumberyesThe evaluation time in microseconds, as the engine measured it (a measurement of this run, never a budget).
engine_versionstringyes
fail_closedbooleanyesTrue when the action applies only because the compliance tag resolved an error or a timeout.
hookHookPointyes
object"policy_evaluation"yes
outcomePolicyOutcomeyes
outputanyyesThe engine's output as it returned it; null on an error.
policy_idPolicyIdyes
rule_idstring or nullyesThe _id of the table row that matched (the _rule output), or null.
tracearray or nullyesThe engine trace when the request asked for it; null otherwise. Returned, never stored.
versioninteger or "draft"yesThe version that ran, or draft.

Used by

The operations whose parameters, request body or responses name this shape directly.