Search Automation run

POST

/v1/object-types/hospitality.automation_run/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.automation_run/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.automation_run/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id automation_ref fired_at condition_kind triggering_object_type effect_kind effect_target outcome effect_correlation_id recorded_correlation_id approval_gate_ref error_text cascade_depth correlation_id

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

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

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

{
  "data": [
    {
      "object_type": "hospitality.automation_run",
      "properties": {
        "condition_kind": "object_set_added",
        "effect_kind": "apply_action",
        "outcome": "effect_applied"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Automation run

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required