Preview Create housekeeping task (dry-run)

POST

/v1/actions/hospitality.action.create_housekeeping_task/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.create_housekeeping_task/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "assignee_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "business_date": "2026-04-15", "credits": "example", "due_at": "2026-04-15T12:00:00Z", "from_triage_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "notes": "example", "priority": "low", "requested_by": "guest", "standard_minutes": 1, "stay_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "task_type": "stayover" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.room" } }'

• Production API

Scenario preview of apply_hospitality_action_create_housekeeping_task — 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.create_housekeeping_task: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

assignee_id

Staff member to assign the task to in the same write — someone at the room's house; a housekeeper or runner session names only itself

string format: uuid

business_date

Service date (defaults to the property-local business day)

string format: date

credits

Credits the task is worth, overriding the house's credit rule (zero or more)

string format: decimal

due_at

When the work is due (no earlier than the start of the day before the house's today)

string format: date-time

from_triage_id

The triaged guest request that asked for this, if one did — links the task back to the conversation so the lane closing the loop knows where to reply

string format: uuid

notes

Notes for the attendant

string

priority

Priority (defaults to normal)

string

Allowed values: low normal high urgent

requested_by

Who asked: guest, desk, floor, pms or automation (defaults from the caller — guest when stay_id or from_triage_id is named)

string

Allowed values: guest desk floor pms automation

standard_minutes

Minutes the work should take, overriding the house's credit rule (1 to 1440)

integer

stay_id

The guest stay that asked for the work — a stay at the task's house

string format: uuid

task_type

required

Kind of work

string

Allowed values: stayover departure vacant_pickup deep_clean turndown inspection public_area_clean public_area_inspection minibar laundry

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

target

required

object

id

required

string format: uuid

object_type

required

Allowed value: hospitality.room

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

link_type

required

Allowed values: hospitality.link.housekeeping_task_for_room hospitality.link.housekeeping_task_requested_by_stay hospitality.link.housekeeping_task_from_triage hospitality.link.housekeeping_task_assigned_to hospitality.link.housekeeping_task_for_area

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.housekeeping_task

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",
      "link_type": "hospitality.link.housekeeping_task_for_room"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.housekeeping_task"
    }
  ]
}

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.