Skip to content
aerandil.com
GitHub

Read Board sort pattern

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

Read an existing instance.

The order a property sets for one of its boards (hubOS’s server-defined sort pattern): the attendant’s housekeeping sheet, the supervisor’s rack, the engineer’s work-order board, or the pacing report. keys is an ordered list — the first key decides, the next breaks its ties — each with a direction and, for a ranked key (priority, task type, status), the house’s order of its values (departures before stayovers, say). One per board per house, authored by set_board_sort_pattern (a repeated board replaces it in place) and retired by retire_board_sort_pattern, which gives the board back to the kernel’s default. A staff member’s own preference (staff_member.sort_preferences) wins over it; hospitality.function.board_sort reads the order a caller sees.

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.board_sort_pattern
properties
required
object
board
required
The board this pattern orders
string
Allowed values: housekeeping_sheet housekeeping_rack work_orders pacing
id
required
Board sort pattern id
string
keys
required
Board sort pattern keys

The keys the board is ordered by, first key first — each a key valid for the board, a direction, and for a ranked key optionally the order of its values

Array<object>
object
direction
required
string
Allowed values: asc desc
key
required
string
Allowed values: priority room_number floor task_type status due_at credits arrival_time departure_time pending_credits target_percent name
values
Array<string>
retired_at
When the pattern was retired
string format: date-time
status
required
Active (orders the board) or retired (the kernel's default does)
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.board_sort_pattern",
  "properties": {
    "board": "housekeeping_sheet",
    "keys": [
      {
        "direction": "asc",
        "key": "priority"
      }
    ],
    "status": "active"
  },
  "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).