POST /simulation/export
Export Simulations
Export all simulations as a clean, denormalized CSV.
Request Body (ExportSimulationApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
simulation_id | string | No | UUID of the simulation to export |
search | string | No | Search query text |
filter_scenario_ids | string[] | No | Filter by scenario UUIDs |
filter_cohort_ids | string[] | No | Filter by cohort UUIDs |
filter_department_ids | string[] | No | Filter by department UUIDs |
idempotency_key | string | No | Idempotency key — replays the prior export instead of re-running |
soft | boolean | No | Stage the export dormant (active=False); ack with accept activates it |
accept | boolean | No | Ack: True promotes the staged export, False rejects. Only meaningful with idempotency_key |
Response (ExportSimulationApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
file_id | string | Yes | UUID of the files_resource holding the export CSV |
file_name | string | Yes | Suggested download file name |
row_count | integer | Yes | Number of data rows in the export |
idempotency_key | string | No | Server-minted soft-call key (audit call_id). On a soft propose, echo this back with accept to promote/reject the staged export. |
Last updated on