Search Workflow definition

POST

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.workflow_definition/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.workflow_definition/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.

Versioned, declarative workflow template. A definition pins step graph, schemas, retry/timeout/compensation policies, and the definition_hash over the canonical JSON form so every run can prove what shape it executes. After status = active all step/schema/policy fields are immutable; changes create a new version (proposal 0020 §4.1).

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.workflow_definition: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 workflow_key version status title description trigger_kind compensation_policy high_risk_policy owner_principal published_at deprecated_at definition_hash changelog_note

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

properties

required

object

changelog_note

Human explanation for active/deprecated versions

string

compensation_policy

required

How the definition handles compensation after a failed terminal run

string

Allowed values: none best_effort required_for_side_effects manual_only

default_retry_policy

Default retry settings inherited by steps unless overridden

definition_hash

required

SHA-256 over canonical JSON of the definition. Runs pin this value.

string

deprecated_at

Set when status becomes deprecated

string format: date-time

description

Bounded to 2048 characters

string

high_risk_policy

required

How the definition treats steps with high `risk_tier`

string

Allowed values: forbid_auto_apply require_gate allow_with_policy

required

Definition id

string

input_schema

required

JSON-Schema-shaped typed parameter contract for `start_workflow_run`

output_schema

JSON-Schema-shaped result contract for completed runs

owner_principal

`Principal::stable_id()` of the maintainer / service owning the definition

string

published_at

Set when draft becomes active

string format: date-time

status

required

Lifecycle status

string

Allowed values: draft active deprecated retired

step_definitions

required

Ordered step definitions per §4.1.1. Stored as JSON for v1 — the typed step-definition shape (step_key, step_type, depends_on, action_name, parameter_template, idempotency_scope, retry_policy, compensation, approval_policy, wait_policy, branch_policy, subworkflow_ref, external_task_kind, executor_policy, risk_tier) is enforced by the workflow_definition validators in commit 9.

timeout_policy

Run-level timeout / expiry settings

title

required

Human-readable name

string

trigger_kind

required

What kind of caller starts runs of this definition

string

Allowed values: manual event schedule webhook agent_requested api

version

required

Operator-controlled semantic version or date. Immutable after activation.

string

workflow_key

required

Stable key under the tenant namespace (e.g. `late_checkout_exception`)

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.workflow_definition",
      "properties": {
        "compensation_policy": "none",
        "high_risk_policy": "forbid_auto_apply",
        "status": "draft",
        "trigger_kind": "manual"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Workflow definition

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required