Preview Enroll federated participant (dry-run)

POST

/v1/actions/hospitality.action.enroll_federated_participant/preview

curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.enroll_federated_participant/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "activate": true, "agent_installation_id": "example", "allowed_analysis_kinds": [ "federated_analytics" ], "consent_policy_reference": "example", "contribution_weight_cap": "example", "credential_reference": "example", "dpa_reference": "example", "excluded_field_classes": [ "example" ], "excluded_object_types": [ "example" ], "legal_basis_kind": "contract", "legal_basis_reference": "example", "local_execution_mode": "operator_runner", "output_access_level": "none", "participant_object_ref": "example", "participant_scope": "tenant" }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_intelligence_program" } }'

• Production API

Scenario preview of apply_hospitality_action_enroll_federated_participant — 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.enroll_federated_participant: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

activate

True to activate; false leaves status = reviewing

boolean

agent_installation_id

Required when execution mode is agent_installation

string

allowed_analysis_kinds

required

Participant-allowed analysis kinds

Array<string>

Allowed values: federated_analytics federated_learning private_set_intersection clean_room_query benchmark_export

consent_policy_reference

Required if consent is the basis

string

contribution_weight_cap

Participant-specific cap stricter than definition

string format: decimal

credential_reference

Opaque pointer; no secret material

string

dpa_reference

Required for cross-tenant programs

string

excluded_field_classes

Additional local privacy exclusions

Array<string>

excluded_object_types

Tenant-specific exclusions

Array<string>

legal_basis_kind

required

Legal basis kind

string

Allowed values: contract legitimate_interest consent public_task not_personal_data other_reviewed

legal_basis_reference

Required except not_personal_data with reviewer note

string

local_execution_mode

required

operator_runner / agent_installation / hosted_connector / third_party_clean_room

string

Allowed values: operator_runner agent_installation hosted_connector third_party_clean_room

output_access_level

required

Output-access tier

string

Allowed values: none aggregate_only participant_benchmark model_consumer

participant_object_ref

Property / venue id when scope is not tenant

string

participant_scope

required

tenant / property / portfolio / venue

string

Allowed values: tenant property portfolio venue

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

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.federated_participation_in_program hospitality.link.federated_local_runner_agent_installation hospitality.link.federated_participation_for_property hospitality.link.federated_participation_for_venue

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

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

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.