Read Automation run

GET

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

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

Read an existing instance.

A frozen, auditable record of one automation firing: which objects tripped the condition (with their current + previous image), which effect fired, and the terminal outcome (effect_applied, staged_for_approval, effect_failed, or suppressed). Written by the host-side evaluator via the internal record_automation_run action; immutable post-insert like every other Aerandil audit artefact. The effect_correlation_id joins to the chained action’s event stream; approval_gate_ref joins to the staged gate.

Authorizations

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

properties

required

object

approval_gate_ref

For `staged_for_approval`: the opened 0020 approval_gate id (`automation_run_outcome_coherent`)

string

automation_ref

required

The automation that fired (id of the `automation` object)

string

cascade_depth

required

This firing's depth in the trigger chain (0 = directly operator/data-driven)

integer

condition_kind

required

Snapshot of the automation's condition kind at firing time

string

Allowed values: object_set_added object_set_removed object_set_modified object_set_all time_cron event_named

correlation_id

required

Trigger-lineage anchor — shared across a cascade so depth and cycles are traceable

string

effect_correlation_id

For `effect_applied` on `apply_action`: the chained action's correlation id — the audit-trail join (`automation_run_outcome_coherent`)

string

effect_input_snapshot

The resolved effect input the evaluator dispatched — the audit-grade record of what actually fired

effect_kind

required

Snapshot of the effect kind fired

string

Allowed values: apply_action call_function send_notification

effect_target

The action/function fired (ApiName form; absent for `send_notification`)

string

error_text

For `effect_failed`: the error the effect returned (`automation_run_outcome_coherent`)

string

fired_at

required

When the evaluator dispatched the effect

string format: date-time

required

Automation run id

string

outcome

required

Terminal outcome of the firing

string

Allowed values: effect_applied staged_for_approval effect_failed suppressed

recorded_correlation_id

The correlation id this run was itself recorded under — stamped by `record_automation_run` from its own invocation, so every event the recording emits joins back to the run and the cascade guard sees the lane's own bookkeeping as an echo, never a fresh depth-0 trigger

string

triggering_delta_snapshot

For `object_set_modified`: the before/after delta the evaluator matched; bounded excerpts only

triggering_object_refs

Ids of the objects that tripped the condition (JSON array; bounded); for `event_named`, the triggering event's sequence number

triggering_object_type

The watched object type (absent for `time_cron`); for `event_named`, the named event type that tripped it

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.automation_run",
  "properties": {
    "condition_kind": "object_set_added",
    "effect_kind": "apply_action",
    "outcome": "effect_applied"
  },
  "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).