VocalDocscontracts 1.65.0

Policy

A Policy (1.47.0): the editable draft of a rule bound to one hook with one action type, with the lint analysis of the draft's document. Calls run published Policy versions, never the draft.

An object with 21 fields.

Fields

FieldTypeRequiredDescription
action_typePolicyActionTypeyesThe one action type the document may output; its legality at hook is checked at save.
active_versioninteger or nullyesThe version Agent version publish pins (agent scope) or dispatch resolves (organization scope), or null when none is active.
analysisPolicyAnalysisyes
archived_atTimestamp or nullyesWhen DELETE archived the Policy, or null. An archived Policy takes no write, publish or activation (409 policy_archived); its pinned versions keep running.
compliance_tagComplianceTag or nullyes
created_atTimestampyes
descriptionstring or nullyesFor reviewers; never sent to the model.
enabledbooleanyesThe kill switch, read at dispatch and effective from the next Call; not part of any version.
hookHookPointyes
idPolicyIdyes
latest_versioninteger or nullyesThe highest published version, or null before the first publish.
logicJdmDocumentyes
namePolicyNameyes
object"policy"yes
organization_idOrganizationIdyes
originPolicyOriginyes
priorityintegeryesLower runs first; ties go to organization scope, then to the id.
revisionintegeryesCounts writes to the draft; returned as the ETag and required in If-Match.
scopePolicyScopeyes
setting_pathSettingPath or nullyesFor a derived Policy, the setting it was compiled from; null when authored.
updated_atTimestampyes

Used by

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