Skip to content
aerandil.com
GitHub

Read Proposed action

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

Read an existing instance.

A frozen, auditable record of an action an agent intends to fire, surfaced for human/guest confirmation. Carries the target action name, the frozen proposed parameters, the rationale, and the context the agent saw. On confirm_proposed_action the kernel — not the agent — fires the chained typed action through the normal scope-checked, idempotency-keyed action surface; the agent never touches state directly (single-write-surface honesty, proposal 0030 §1). The decision_* / applied_* fields mutate exactly once on the transition out of proposed. Supersession is on the proposed_action_superseded_by self-link.

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.proposed_action
properties
required
object
applied_action_correlation_id
The chained typed action's correlation id — the audit-trail join
string
applied_params
The params actually fired on `applied` — may differ from `target_params_snapshot` when the confirmer edited them (the edit-rate trust signal, §7)
applied_target_ref
Id of the object the chained action created/modified
string
confidence
required
Agent confidence in the proposal
string
Allowed values: low medium high
context_snapshot
Frozen context the agent saw (the guest request, the disruption); bounded excerpts only — full content stays in the system of record
decided_at
Set on exit from `proposed`
string format: date-time
decided_by
Principal::stable_id() of the confirming principal (guest surface, staff member, approval gate, or the expiry sweep)
string
decision_status
required
Frozen-artefact lifecycle status
string
Allowed values: proposed applied rejected expired superseded
expires_at
required
When an unconfirmed proposal sweeps to `expired` (default 24h)
string format: date-time
id
required
Proposal id
string
proposed_by
required
Principal::stable_id() of the proposing agent — the audit anchor
string
rationale_text
Human-readable 'why', surfaced at confirmation time
string
rejection_reason
Set on `rejected`
string
requires_confirmation_from
required
Who must confirm before the kernel fires the action
string
Allowed values: guest staff approval_gate
subject_kind
required
The object class the action targets
string
Allowed values: reservation person folio charge stay venue other
subject_ref
required
Id of the subject object (resolved against `subject_kind`)
string
target_action
required
The registered action this proposal intends to fire (ApiName form); validated against the registry
string
target_params_snapshot
Frozen proposed parameters for `target_action` — the audit-grade record of what the agent wanted to do
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.proposed_action",
  "properties": {
    "confidence": "low",
    "decision_status": "proposed",
    "requires_confirmation_from": "guest",
    "subject_kind": "reservation"
  },
  "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).