Skip to Content

POST /document/draft

Patch Document Draft

Patch document draft — composable infra architecture.

Request Body (PatchDocumentDraftApiRequest)

FieldTypeRequiredDescription
draft_idstringNoExisting draft UUID to patch
input_draft_idstringNoLegacy alias for existing draft UUID to patch
namestringNoName value to create a resource
name_idstringNoExisting name resource UUID
descriptionstringNoDescription value to create a resource
description_idstringNoExisting description resource UUID
filesDraftFileValue[]NoFile values to create resources
file_idsstring[]NoExisting file resource UUIDs
textsDraftTextValue[]NoText values to create resources
text_idsstring[]NoExisting text resource UUIDs
imagesapp__infra__document__types__DraftImageValue[]NoImage values to create resources
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
activebooleanNoDenormalized document_active flag state; resolved to a flag_ids entry server-side
department_idsstring[]NoDepartment UUIDs
image_idsstring[]NoImage UUIDs
parameter_field_idsstring[]NoParameter field UUIDs
parameter_idsstring[]NoParameter UUIDs
pending_idsstring[]NoResource IDs to keep as pending where supported by the tool layer
idempotency_keystringNoOperation key for ack or retry
softbooleanNoStage the draft dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept (promote) or reject dormant state. Only meaningful with idempotency_key

Response (PatchDocumentDraftApiResponse)

FieldTypeRequiredDescription
successbooleanYesWhether the operation succeeded
draft_idstringYesDraft UUID
idempotency_keystringYesIdempotency key for this draft operation
messagestringYesHuman-readable result message
form_stateapp__infra__document__types__DraftFormStateNoServer-authoritative form state
Last updated on