Skip to content
aerandil.com
GitHub

Search Round template

POST
/v1/object-types/hospitality.round_template/search
curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.round_template/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid
cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string
filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array
One of:
object
property
required
Allowed value: id
type
required
Allowed value: eq
value
required
string
limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer
>= 1 <= 500
order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string
default: asc
Allowed values: asc desc
property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid
scope
One of: discriminator: level
object
level
required
string
Allowed value: tenant
Allowed values: tenant
sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string
default: created_at
Allowed values: created_at updated_at id name description family cadence interval_days next_due_on next_due_at status open_round_id last_completed_on retired_at revision

Responses

Section titled “Responses”

200

Section titled “200”

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
id
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
id
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
has_more
required
boolean
next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string
Example
{
  "data": [
    {
      "object_type": "hospitality.round_template",
      "properties": {
        "cadence": "fixed",
        "checkpoints": [
          {
            "items": [
              {
                "kind": "check"
              }
            ],
            "kind": "room"
          }
        ],
        "family": "corrective",
        "status": "active"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Section titled “422”

Validation error — unknown property or filter type mismatch.