Read Fault type as of a watermark

GET

/v1/object-types/hospitality.fault_type/objects/{id}/as-of

const url = 'https://api.aerandil.com/v1/object-types/hospitality.fault_type/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/as-of?at=example';
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.fault_type/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/as-of?at=example' \
  --header 'Authorization: Bearer <token>'

Time-travel read: the instance as it stood at the at watermark, reconstructed by folding its structural events. Property values that were marking-redacted or truncated in the event log surface as sentinel objects, not values.

A kind of fault a house keeps in its catalogue — “no hot water”, “TV remote dead”, “lift stuck between floors” (hubOS’s failure catalogue). Keyed by code within its catalogue: a brand’s (fault_type_at_brand, shared by the brand’s houses) or one house’s (fault_type_at_property); define_fault_type with a code the catalogue holds re-states it in place. It carries the title an order raised from it is given, the room element it is in, the category (the trade that mends it) and the severity it starts at — create_work_order and create_public_area_work_order take fault_type_id and fill each one the call does not state. active, or retired for good (the code stays taken).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.fault_type:read

Parameters

Path Parameters

required

string format: uuid

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

Query Parameters

required

string

The watermark: an event seq (integer, canonical — the /v1/events cursor namespace) or an RFC3339 timestamp (resolved to the latest seq at or before it in the tenant’s stream).

Responses

200

The reconstructed as-of state.

application/json

object

required

string

events_applied

required

integer

required

string format: uuid

last_event_seq

required

integer

last_event_ts

required

string format: date-time

object_type

required

Allowed value: hospitality.fault_type

properties

required

Log-shaped folded bag: each entry is a typed {kind, value} object, a {redacted: [markings]} sentinel, or a {truncated_bytes: n} sentinel.

object

key

additional properties

any

Example

{
  "object_type": "hospitality.fault_type"
}

404

Object did not exist at the watermark (not yet created, or already deleted).

422

Malformed at, or the object’s history predates structural event images and cannot back a faithful reconstruction.