Define round template
const url = 'https://api.aerandil.com/v1/actions/hospitality.action.define_round_template/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","params":{"cadence":"fixed","checkpoints":[{"items":[{"code":"example","kind":"check","label":"example","max":"example","min":"example","unit":"example"}],"kind":"room","label":"example","position":1,"ref_id":"example"}],"description":"example","family":"corrective","interval_days":1,"name":"example","next_due_on":"2026-04-15"},"return_modified":false,"target":{"id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","object_type":"hospitality.property"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.aerandil.com/v1/actions/hospitality.action.define_round_template/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "cadence": "fixed", "checkpoints": [ { "items": [ { "code": "example", "kind": "check", "label": "example", "max": "example", "min": "example", "unit": "example" } ], "kind": "room", "label": "example", "position": 1, "ref_id": "example" } ], "description": "example", "family": "corrective", "interval_days": 1, "name": "example", "next_due_on": "2026-04-15" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'Define a house’s planned walk — hubOS’s revision structure: its name, family (corrective, preventive, technical_legal, inspection_legal), cadence (fixed to the calendar or floating from the last completion, every interval_days — the maintenance plan’s vocabulary) and the checkpoints in walking order. Each checkpoint has a unique position, a kind — room or asset with ref_id naming one of this house’s rooms or (unretired) assets, or general with a label and no ref_id — and its items, each a unique code, a label and a kind (check; reading with an optional unit and optional limits min / max, inclusive, which judge a reading the walker leaves unjudged; text; photo, answered by a photo on the checkpoint’s result; section, a heading never answered — a checkpoint needs at least one item that is not a heading). Replay-safe by its business key, house × name: the same name again revises the active template’s family, cadence, description and checkpoints in place (an identical repeat writes nothing; a round already under way keeps the checkpoints it started with). The template carries its revision — 1 when defined, one more each time a re-definition moves its checkpoints (words and schedule leave it) — which a start may name. next_due_on is the date the next round is due — required the first time; on a revision, absent keeps the schedule. After retire_round_template the name mints a new template. Emits round_template.defined.
Effects: create hospitality.round_template; modify hospitality.round_template; link hospitality.link.round_template_at_property.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).
object
object
object
When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.
object
Responses
Section titled “Responses”Action applied. modified_objects and modified_links populated when return_modified: true was supplied.
Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.
object
Per-invocation correlation id; matches events.correlation_id for every event this action appended.
Links established or removed by this invocation. Empty when the caller did not request return_modified.
object
Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.
object
Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.
object
Human-readable summary, suitable for logging or operator-UI surfacing.
Object type the warning was raised against.
Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.
Stable kebab-case rule identifier (e.g. comp-authority-over-limit).
Example
{ "modified_links": [ { "kind": "linked", "link_type": "hospitality.link.round_template_at_property" } ], "modified_objects": [ { "kind": "created", "object_type": "hospitality.round_template" } ]}Conflict — concurrent modification or unique constraint violation.
Validation error — parameter validation or business-rule violation.