Skip to content
aerandil.com
GitHub

Read Maintenance plan

GET
/v1/object-types/hospitality.maintenance_plan/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.maintenance_plan/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

A room’s preventive-maintenance cadence: the work order to raise (title, category, severity), how often — fixed to the calendar or floating from the last completion, every interval_days — and when it is next due. Holds state only; the automation lane is its clock: a sweep over plans whose due instant has come — next_due_at, the house’s own midnight starting next_due_on — raises the work order (raise_maintenance_work_order, the plan goes raised), and a monitor on that order reaching complete or void moves the plan on (advance_maintenance_plan, back to scheduled with the next due date). One open order per plan at a time.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “Query Parameters”
branch
string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.maintenance_plan
properties
required
object
cadence
required
Fixed to the calendar, or floating from the last completion
string
Allowed values: fixed floating
category
required
Category of the raised work orders
string
Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other
description
Detail carried onto each raised work order
string
id
required
Maintenance plan id
string
interval_days
required
Days between occurrences
integer
last_completed_on
The property-local date its last work order was completed
string format: date
last_raised_at
When the plan last raised a work order
string format: date-time
next_due_at
The instant the house's day reaches next_due_on — its local midnight in the property's timezone (UTC midnight when it has none); what the raise sweep compares with the lane's clock, written beside next_due_on by the plan's verbs
string format: date-time
next_due_on
required
The date the next work order is due
string format: date
retired_at
When the plan was retired
string format: date-time
severity
required
Severity of the raised work orders
string
Allowed values: cosmetic minor major blocking safety
status
required
Scheduled (waiting for its date), raised (its order is open), or retired
string
Allowed values: scheduled raised retired
title
required
What the raised work order says to do
string
provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object
pins
object
key
additional properties
object
pinned_at
string format: date-time
pinned_by
object
reason
required
string
properties
object
key
additional properties
object
external_id
string
recorded_at
required
string format: date-time
source
required
string
source_updated_at
string format: date-time
stream
string
scope
required
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
tenant_id
required
string format: uuid
updated_at
required
string format: date-time
version
required
integer
>= 1
Example
{
  "object_type": "hospitality.maintenance_plan",
  "properties": {
    "cadence": "fixed",
    "category": "hvac",
    "severity": "cosmetic",
    "status": "scheduled"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “Headers”
ETag
string
/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

Section titled “404”

No object with that id (or soft-deleted).