Read Work order entry

GET

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

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

Read an existing instance.

One line on a work order’s thread — hubOS’s fault logbook thread as typed data: a note, work (minutes spent), material (parts used), a delegation to another role, the postponement (written by postpone_work_order, with the date and reason) or the resolution (written by complete_work_order). Linked to its order (work_order_entry_for_work_order) and to the staff member who wrote it when one did (work_order_entry_recorded_by); recorded_by names the principal either way. Append-only: a correction is another line. Photos hang off an entry as attachments. The order’s time and parts are the sum of its entries — a query, not a stored total.

Authorizations

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

properties

required

object

delegated_to_role

The role the order is handed to (a delegation line)

string

Allowed values: front_office_agent front_office_supervisor concierge bell housekeeper housekeeping_supervisor engineer food_beverage_server food_beverage_manager chef spa_therapist spa_manager reservations_agent revenue_manager sales_manager manager_on_duty general_manager owner other runner

required

Work order entry id

string

kind

required

What the line records: note, work, material, delegation, postponement, resolution

string

Allowed values: note work material delegation postponement resolution

materials

Work order entry materials

Parts used: description, quantity, optionally a unit, and the catalogued material and store a consumed part came from

Array<object>

object

description

string

material_id

string format: uuid

quantity

required

string format: decimal

store_id

string format: uuid

unit

string

minutes_spent

Time spent on the work this line logs, in minutes (at most a week per line)

integer

postponed_until

The date the order was postponed to (a postponement line)

string format: date

recorded_at

required

When the line was written — the handset's own time when it queued offline

string format: date-time

recorded_by

required

The principal that wrote the line (`user:…`, `agent:…`, `service:…`, `system`)

string

text

The words on the line (required for a note, a postponement's reason, a resolution)

string

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.work_order_entry",
  "properties": {
    "delegated_to_role": "front_office_agent",
    "kind": "note"
  },
  "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).