Skip to content
aerandil.com
GitHub

Validate Record federated aggregation result (dry-run)

POST
/v1/actions/hospitality.action.record_federated_aggregation_result/validate
curl --request POST \
  --url https://api.aerandil.com/v1/actions/hospitality.action.record_federated_aggregation_result/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "params": { "aggregate_payload_hash": "example", "aggregate_payload_reference": "example", "aggregation_status": "succeeded", "draft_output_kind": "benchmark_report", "draft_output_schema_version": "example", "failure_reason": "example", "participants_accepted": 1, "participants_suppressed": 1, "privacy_budget_spend": "example", "suppression_reasons": [ "minimum_tenants_not_met" ] }, "return_modified": false, "target": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "object_type": "hospitality.federated_run" } }'

Dry-run of apply_hospitality_action_record_federated_aggregation_result’s parameter checks. No side effects, no idempotency reservation, no handler dispatch — just the schema pass plus action-level shape (target presence, target type, unknown-parameter rejection). return_modified is meaningless here and ignored.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
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
aggregate_payload_hash
Required when aggregate_payload_reference is set
string
aggregate_payload_reference
Aggregate payload reference (opaque)
string
aggregation_status
required
succeeded | failed | quarantined
string
Allowed values: succeeded failed quarantined
draft_output_kind
Output kind for the draft output created on success
string
Allowed values: benchmark_report calibration_curve aggregate_metric model_artifact signal_package governance_card
draft_output_schema_version
Output schema version for the draft output
string
failure_reason
Bounded; required for failed / quarantined
string
participants_accepted
required
Accepted participant count
integer
participants_suppressed
required
Suppressed participant count
integer
privacy_budget_spend
required
Actual budget spend (JSON)
suppression_reasons
Reasons for suppression
Array<string>
Allowed values: minimum_tenants_not_met minimum_properties_not_met minimum_subjects_not_met max_contributor_share_exceeded privacy_budget_exhausted high_variance data_quality_mismatch legal_basis_missing participant_withdrawal reviewer_blocked security_incident
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_run

Responses

Section titled “Responses”

200

Section titled “200”

Validation outcome. result is valid or invalid; per-parameter diagnostics are always populated for every declared parameter so a UI can render the action’s full surface.

Media typeapplication/json
object
action
required
string
errors

Action-level errors not tied to a single parameter (missing target, target type mismatch, unknown parameter names). Absent when empty.

Array<string>
parameters
required

Per-parameter diagnostics keyed by api_name.

object
key
additional properties
object
errors
Array<string>
result
required
Allowed values: valid invalid
value
required

The serialised value the server interpreted, or null if the parameter was not supplied.

result
required
Allowed values: valid invalid
Example
{
  "parameters": {
    "additionalProperty": {
      "result": "valid"
    }
  },
  "result": "valid"
}