Search Workflow step run

POST

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

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

One step’s runtime state inside a workflow run. A retry increments attempt_count; a new step run row is created only for fan-out branches or subworkflow children. context_hash is the canonical JCS+SHA-256 over the proposal §4.4.2 input set; drift supersedes any held approval. The self-reference for compensation is on the workflow_step_run_compensates_step_run link, not an inline UUID.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.workflow_step_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 step_key step_type status action_name function_name context_hash idempotency_key attempt_count max_attempts next_attempt_at started_at completed_at last_error_code last_error_summary last_result_status external_reference executed_by compensation_role

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_step_run

properties

required

object

action_name

Copied from definition for action steps

string

attempt_count

required

Starts at 0; increments before each attempt

integer

compensation_role

Marker for rows participating in a compensation relationship. Self-reference uses `workflow_step_run_compensates_step_run`, not an inline UUID.

string

Allowed values: original compensating_step

completed_at

Terminal step time

string format: date-time

context_hash

required

Canonical JCS+SHA-256 over the §4.4.2 input set

string

executed_by

`Principal::stable_id()` that executed or resolved the step

string

external_reference

PSP, PMS, Slack, Linear, webhook, or job reference

string

function_name

Copied from definition for function steps

string

required

Step run id

string

idempotency_key

Durable key used for mutating action/function/external call

string

last_error_code

Structured failure code

string

last_error_summary

Bounded failure summary

string

last_result_status

Raw result_status last recorded by the runner; failed_retryable normalizes to status waiting_for_retry.

string

Allowed values: succeeded failed_retryable failed_terminal skipped waiting_for_event waiting_for_retry canceled expired

max_attempts

required

From retry policy

integer

next_attempt_at

Set while waiting for retry

string format: date-time

parameter_snapshot

required

Frozen parameters after template resolution

result_snapshot

Frozen, redacted step result

started_at

First attempt start

string format: date-time

status

required

Lifecycle status

string

Allowed values: planned ready running waiting_for_approval waiting_for_event waiting_for_retry succeeded failed_terminal skipped cancel_requested canceled expired compensating compensated compensation_failed

step_key

required

Matches the definition step key

string

step_type

required

Copied from definition

string

Allowed values: action function approval_gate event_wait branch subworkflow external_task

target_ref

Workflow step run target ref

{object_type, object_id} resolved at runtime

object

object_id

required

string

object_type

required

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_step_run",
      "properties": {
        "compensation_role": "original",
        "last_result_status": "succeeded",
        "status": "planned",
        "step_type": "action"
      },
      "scope": {
        "level": "tenant"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Workflow step run

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required