Set board sort pattern

POST

/v1/actions/hospitality.action.set_board_sort_pattern/apply

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.set_board_sort_pattern/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "board": "housekeeping_sheet", "keys": [ { "direction": "asc", "key": "priority", "values": [ "example" ] } ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.property" } }'

• Production API

Set the order of one of the property’s boards — hubOS’s server-defined sort pattern: the attendant’s housekeeping_sheet, the supervisor’s housekeeping_rack, the engineer’s work_orders board, or the pacing report. keys is ordered, first key first, each a key the board’s rows carry (priority, room_number, floor, task_type, status, credits, arrival_time, departure_time on the housekeeping boards; priority — the order’s severity — room_number, floor, status, due_at on work_orders; name, credits, pending_credits, target_percent on pacing) with a direction, and for a ranked key (priority, task_type, status) optionally the house’s order of its values, least first (departures before stayovers). One pattern per board per house: setting a board again replaces its pattern in place and revives it if it was retired; the same order again writes nothing. A staff member’s own preference (set_staff_sort_preference) wins over it; board_sort reads the order a caller sees. Emits board_sort_pattern.set.recorded.

Effects: create hospitality.board_sort_pattern; modify hospitality.board_sort_pattern; link hospitality.link.board_sort_pattern_at_property.

Authorizations

• aerandil_oauth
  actions:apply
• aerandil_oauth
  actions:hospitality.action.set_board_sort_pattern:apply

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

board

required

The board to order

string

Allowed values: housekeeping_sheet housekeeping_rack work_orders pacing

keys

required

Sort keys

Array<object>

object

direction

required

string

Allowed values: asc desc

key

required

string

Allowed values: priority room_number floor task_type status due_at credits arrival_time departure_time pending_credits target_percent name

values

Array<string>

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

Responses

200

Action applied. modified_objects and modified_links populated when return_modified: true was supplied.

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

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 modified

object_type

required

Allowed values: hospitality.board_sort_pattern

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.board_sort_pattern_at_property"
    }
  ],
  "modified_objects": [
    {
      "kind": "created",
      "object_type": "hospitality.board_sort_pattern"
    }
  ]
}

409

Conflict — concurrent modification or unique constraint violation.

422

Validation error — parameter validation or business-rule violation.