Preview Define automation (dry-run)

POST

/v1/actions/hospitality.action.define_automation/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.define_automation/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "approval_policy_ref": "example", "condition_kind": "object_set_added", "cron_expression": "example", "description_text": "example", "display_name": "example", "effect_action": "example", "effect_function": "example", "effect_kind": "apply_action", "effect_notification_template": "example", "effect_params_template": {}, "event_type_ref": "example", "execution_mode": "per_object", "max_cascade_depth": 1, "modified_property_watch": "example", "object_set_filter": "example", "object_type_ref": "example", "requires_approval": true }, "return_modified": false }'

• Production API

Scenario preview of apply_hospitality_action_define_automation — runs the action exactly as apply would (validation, handler dispatch, modified-object projection, commit-time cross-link validation) then rolls the transaction back. Returns the modified_objects / modified_links / warnings the apply would have produced without persisting anything or firing any outward effect. Requires the same actions:hospitality.action.define_automation:apply scope as apply. No Idempotency-Key.

Authorizations

• aerandil_oauth

Request Body^required

Media typeapplication/json

object

branch

Apply against an open branch’s overlay view instead of the canonical (main) plane. The action’s writes land in the branch’s copy-on-first-write overlay, its events in the branch’s own stream, and the invocation is journaled for merge-by-replay. Branch writes are action-only, so this is the write-side entry point to a branch (POST /v1/branches forks one).

string format: uuid

params

required

object

approval_policy_ref

Approval policy the staged gate opens under (required when requires_approval)

string

condition_kind

required

Trigger-predicate class

string

Allowed values: object_set_added object_set_removed object_set_modified object_set_all time_cron event_named

cron_expression

Schedule for time_cron (5-field cron)

string

description_text

What this automation is for

string

display_name

required

Human-readable name shown in the operator console

string

effect_action

Registered action to fire (for apply_action)

string

effect_function

Read-only function to invoke (for call_function)

string

effect_kind

required

Effect fired when the condition is met

string

Allowed values: apply_action call_function send_notification

effect_notification_template

Templated notification body/target (for send_notification, JSON)

effect_params_template

Template mapping triggering-object fields → effect input (JSON)

object

key

additional properties

any

event_type_ref

Named domain event watched (required for event_named)

string

execution_mode

Per-object vs batch effect firing (default per_object)

string

Allowed values: per_object batch

max_cascade_depth

Loop guard: max trigger-chain depth before suppression (default 3)

integer

modified_property_watch

Property api-names whose change trips object_set_modified (JSON array)

object_set_filter

Search-filter predicate defining the watched object set (JSON)

object_type_ref

Watched object type (required for object_set_* kinds)

string

requires_approval

Route the effect through a 0020 approval_gate instead of applying

boolean

return_modified

When true, the response carries modified_objects and modified_links projections — the engine reads the event log inside the same transaction so the projection observes the handler’s own writes.

boolean

Responses

200

Preview computed and rolled back. modified_objects and modified_links carry the effect set the apply would produce; preview is always true.

Media typeapplication/json

ApplyActionResponse

Envelope returned by the Aerandil action engine. correlation_id ties every event emitted by this invocation; modified_objects and modified_links project the events the handler emitted (per the action’s declared effects); warnings carries any non-blocking soft-validator observations.

object

correlation_id

required

Per-invocation correlation id; matches events.correlation_id for every event this action appended.

string format: uuid

modified_links

required

Links established or removed by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

from_id

required

string format: uuid

from_type

required

string

kind

required

Allowed values: linked unlinked properties_updated end_dated

link_type

required

string

to_id

required

string format: uuid

to_type

required

string

modified_objects

required

Objects created, modified, or soft-deleted by this invocation. Empty when the caller did not request return_modified.

Array<object>

object

id

required

string format: uuid

kind

required

Allowed values: created

object_type

required

Allowed values: hospitality.automation

warnings

Non-blocking soft-validator observations emitted during this invocation (e.g. comp-authority over-limit, recipe pour-cost over sell-price). Absent when no warnings were emitted.

Array<object>

object

message

required

Human-readable summary, suitable for logging or operator-UI surfacing.

string

object_type

required

Object type the warning was raised against.

string

property

Property the warning anchors to, when a single field is the locus. Absent for multi-field rules.

string

rule

required

Stable kebab-case rule identifier (e.g. comp-authority-over-limit).

string

Example

{
  "modified_links": [
    {
      "kind": "linked"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.automation"
    }
  ]
}

Headers

Cache-Control

string

Allowed value: no-store

Always no-store — uncommitted live data.

409

Conflict — concurrent modification or unique constraint violation the apply would hit.

422

Validation error — the apply would be rejected.