Read Checklist result

GET

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

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

Read an existing instance.

One recording of a checklist template against one housekeeping task (checklist_result_for_task, checklist_result_for_template): the answered items, the recorder’s remarks, who ticked it (checklist_result_recorded_by) and when. score is derived, never typed: the template’s check items ticked ok ÷ all its check items, × 100, rounded half up — checks_passed and checks_total are its evidence; a template with no check items scores nothing. Photo items’ pictures hang off the result as attachments (stored_object_for_checklist_result). One result per task × template: recording again replaces it in place while the task is open. A supervisor’s inspection list is the same object recorded against the inspection task.

Authorizations

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

properties

required

object

checks_passed

required

How many of those were ticked ok

integer

checks_total

required

How many of the template's items are `check` items

integer

required

Checklist result id

string

items

required

Checklist result items

The answered items, by template item code

Array<object>

object

code

required

string

required

boolean

remark

string

value

string

recorded_at

required

When the list was ticked (the handset's tap, when it says)

string format: date-time

remarks

The recorder's remarks on the whole list

string

score

checks_passed ÷ checks_total × 100, rounded half up; absent when the template has no check items

integer

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.checklist_result",
  "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).