Define maintenance plan

POST

/v1/actions/hospitality.action.define_maintenance_plan/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_maintenance_plan/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "asset_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cadence": "fixed", "category": "hvac", "description": "example", "first_due_on": "2026-04-15", "interval_days": 1, "severity": "cosmetic", "title": "example" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

• Production API

Put a room on a preventive-maintenance cadence: the work order to raise (title, category, severity, description), every interval_days, fixed to the calendar or floating from the last completion (UpKeep’s and Maximo’s switch), first due on first_due_on. The plan starts scheduled; the automation lane raises its order when the date comes. Emits maintenance_plan.defined.

Effects: create hospitality.maintenance_plan; link hospitality.link.maintenance_plan_for_room; link hospitality.link.maintenance_plan_for_asset.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.define_maintenance_plan:apply

Request Body^required

Media typeapplication/json

object

branch

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).

string format: uuid

params

required

object

asset_id

The equipment the plan looks after (same house, not retired); each raised order is for it too, and retiring it retires the plan

string format: uuid

cadence

required

fixed (to the calendar) or floating (from the last completion)

string

Allowed values: fixed floating

category

required

Work order category

string

Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other

description

Detail carried onto each raised work order

string

first_due_on

required

The first due date

string format: date

interval_days

required

Days between occurrences (1 to 3650)

integer

severity

required

Work order severity

string

Allowed values: cosmetic minor major blocking safety

title

required

What each raised work order says to do

string

return_modified

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.

boolean

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.room

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

Media typeapplication/json

ApplyActionResponse

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

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked

link_type

required

Allowed values: hospitality.link.maintenance_plan_for_room hospitality.link.maintenance_plan_for_asset

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created

object_type

required

Allowed values: hospitality.maintenance_plan

warnings

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.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked",
      "link_type": "hospitality.link.maintenance_plan_for_room"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.maintenance_plan"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.