POST /document/draft
Patch Document Draft
Patch document draft — composable infra architecture.
Request Body (PatchDocumentDraftApiRequest)
| 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 |
files | DraftFileValue[] | No | File values to create resources |
file_ids | string[] | No | Existing file resource UUIDs |
texts | DraftTextValue[] | No | Text values to create resources |
text_ids | string[] | No | Existing text resource UUIDs |
images | app__infra__document__types__DraftImageValue[] | No | Image values to create resources |
flag_ids | string[] | No | Selected flag option UUIDs — canonical; server derives semantics by flag type/value |
active | boolean | No | Denormalized document_active flag state; resolved to a flag_ids entry server-side |
department_ids | string[] | No | Department UUIDs |
image_ids | string[] | No | Image UUIDs |
parameter_field_ids | string[] | No | Parameter field UUIDs |
parameter_ids | string[] | No | Parameter UUIDs |
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 (promote) or reject dormant state. Only meaningful with idempotency_key |
Response (PatchDocumentDraftApiResponse)
| 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__document__types__DraftFormState | No | Server-authoritative form state |
Last updated on