Read Asset

GET

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

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

Read an existing instance.

A piece of equipment a house maintains — the boiler, a room’s air conditioner, the kitchen’s walk-in (hubOS’s hardware). Keyed by code, the house’s tag for it, unique within the house: register_asset with a code the house already holds re-states that asset in place. Stands in at most one place — a room (asset_in_room) or a venue (asset_at_venue) — or nowhere in particular. Work orders (work_order_for_asset) and preventive plans (maintenance_plan_for_asset) attach to it as well as to a room, so its service history is a read. active, out_of_service (with the reason) or retired (terminal; its plans retire with it). Manuals and photos hang off it as attachments.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.asset: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.asset

properties

required

object

category

required

The trade that maintains it — the work-order categories

string

Allowed values: hvac plumbing electrical furniture fixtures networking audio_visual structural exterior safety other

code

required

The house's tag for the asset — unique within the house

string

description

Notes on the asset

string

installed_year

Year of installation

integer

make

Manufacturer

string

model

Model

string

name

required

What the asset is, in words ("Boiler 2", "AC unit, room 101")

string

out_of_service_reason

Why the asset is out of service (present exactly while it is)

string

registered_at

required

When the asset was first registered

string format: date-time

retire_reason

Why the asset was retired — removed, replaced, scrapped

string

retired_at

When the asset was retired

string format: date-time

serial

Manufacturer's serial number

string

status

required

active, out_of_service (with the reason), or retired

string

Allowed values: active out_of_service retired

status_changed_at

When the status last changed

string format: date-time

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.asset",
  "properties": {
    "category": "hvac",
    "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).