Read Round template

GET

/v1/object-types/hospitality.round_template/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.round_template/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Read an existing instance.

A house’s planned walk — hubOS’s revision structure: a name, a family (corrective, preventive, technical_legal, inspection_legal), the maintenance plan’s cadence (fixed to the calendar or floating from the last completion, every interval_days) and its next due date, and the checkpoints in order — each a room or a piece of equipment of this house (ref_id), or a general place named by its label, with the items checked there (check, reading with its unit and optional min / max, text, photo, and section headings). One active template per house and name: defining the name again revises it in place. The automation lane is its clock: a sweep over active templates whose due instant has come (next_due_at, the house’s midnight starting next_due_on) and that have no round open starts one (start_inspection_round); completing the round moves next_due_on on. open_round_id names the round in progress; revision counts the walks it has defined (a re-definition that moves the checkpoints is the next), and a start may name the one it saw.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.round_template:read

Parameters

Path Parameters

required

string format: uuid

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

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

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.round_template

properties

required

object

cadence

required

Fixed to the calendar, or floating from the last completion

string

Allowed values: fixed floating

checkpoints

required

Round template checkpoints

The checkpoints, in walking order, each with its items

Array<object>

object

items

required

Array<object>

object

code

required

string

kind

required

string

Allowed values: check reading text photo section

label

required

string

max

string format: decimal

min

string format: decimal

unit

string

kind

required

string

Allowed values: room asset general

label

string

position

required

integer

ref_id

string

description

What the walk is for, in words

string

family

required

corrective, preventive, technical_legal or inspection_legal

string

Allowed values: corrective preventive technical_legal inspection_legal

required

Round template id

string

interval_days

required

Days between rounds

integer

last_completed_on

The property-local date its last round was completed

string format: date

name

required

What the walk is called — unique among the house's active templates

string

next_due_at

The instant the house's day reaches next_due_on — its local midnight (UTC midnight when the house names no timezone); what the start sweep compares with the lane's clock

string format: date-time

next_due_on

required

The date the next round is due

string format: date

open_round_id

The round of this template in progress, when one is — the sweep starts none while it is set

string

retired_at

When the template was retired

string format: date-time

revision

Which revision of the walk this is — 1 when defined, one more each time a re-definition moves its checkpoints (words and schedule do not); absent on a template defined before revisions, which reads as 1. start_inspection_round's template_revision is checked against it

integer

status

required

Active (falls due) or retired

string

Allowed values: active retired

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.round_template",
  "properties": {
    "cadence": "fixed",
    "checkpoints": [
      {
        "items": [
          {
            "kind": "check"
          }
        ],
        "kind": "room"
      }
    ],
    "family": "corrective",
    "status": "active"
  },
  "scope": {
    "level": "tenant"
  }
}

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

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