POST /cohort/draft
Patch Cohort Draft
Patch cohort draft — composable infra architecture.
Request Body (PatchCohortDraftApiRequest)
| Field | Type | Required | Description |
|---|---|---|---|
draft_id | string | No | Existing draft UUID to patch |
input_draft_id | string | No | Legacy alias for existing draft UUID to patch |
name | string | No | Name value to create a resource |
name_id | string | No | Existing name resource UUID |
description | string | No | Description value to create a resource |
description_id | string | No | Existing description resource UUID |
flag_ids | string[] | No | Selected flag option UUIDs — canonical; server derives semantics by flag type/value |
active | boolean | No | Denormalized cohort_active flag state; resolved to a flag_ids entry server-side |
department_ids | string[] | No | Department UUIDs |
departments | string[] | No | Department names to resolve |
simulation_ids | string[] | No | Simulation UUIDs |
simulations | string[] | No | Simulation names to resolve |
profile_ids | string[] | No | Profile UUIDs |
profiles | string[] | No | Profile names to resolve |
simulation_position_ids | string[] | No | Existing simulation position UUIDs |
simulation_positions | DraftSimulationPositionValue[] | No | Simulation position values to create |
simulation_availability_ids | string[] | No | Existing simulation availability UUIDs |
simulation_availability | DraftSimulationAvailabilityValue[] | No | Simulation availability values to create |
profile_persona_ids | string[] | No | Existing profile persona UUIDs |
profile_personas | DraftProfilePersonaValue[] | No | Profile persona values to create |
pending_ids | string[] | No | Resource IDs to keep as pending where supported by the tool layer |
idempotency_key | string | No | Operation key for ack or retry |
soft | boolean | No | Stage the draft dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it |
accept | boolean | No | Accept or reject dormant draft state |
Response (PatchCohortDraftApiResponse)
| Field | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | Whether the operation succeeded |
draft_id | string | Yes | Draft UUID |
idempotency_key | string | Yes | Idempotency key for this draft operation |
message | string | Yes | Human-readable result message |
form_state | app__infra__cohort__types__DraftFormState | No | Server-authoritative form state |
Last updated on