Skip to main content
GET
Get a state template

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

Response

Success.

data
StateTemplateDocument · object
required

A state-template document: the reusable schema fragment plus the parameters, write regimes, attach-time declarations and trace switch the platform owns, plus template_jq (named jq programs — input-purpose reads and update-purpose record operations) and reconcile (how a declarations edit settles open records) that give the record its meaning. A template is data end to end: the states API serves an input-purpose result for a subject and applies an update-purpose program to a subject generically, so a template is usable through the API with no other engine. extra="forbid" refuses any key outside these.

The wire key schema is the attribute schema_ (alias). The declarations, template_jq and reconcile sections carry their served sub-shapes (:class:StateTemplateDeclarations, :class:StateTemplateJq, :class:StateTemplateReconcile); the skeleton store does the semantic validation (jq compilation, regime/record path resolution against the fragment) these models do not.