Skip to Content

POST /parameter/draft

Patch Parameter Draft

Patch parameter draft — composable infra architecture.

Request Body (PatchParameterDraftApiRequest)

FieldTypeRequiredDescription
draft_idstringNoExisting draft ID to update
input_draft_idstringNoLegacy alias for existing draft ID to update
namestringNoDisplay name value
name_idstringNoName resource identifier
descriptionstringNoDescription text value
description_idstringNoDescription resource identifier
flag_idsstring[]NoFlag option identifiers
department_idsstring[]NoDepartment identifiers
field_idsstring[]NoField identifiers
departmentsstring[]NoDepartment names to resolve
parameter_fieldsstring[]NoParameter field names to resolve
pending_idsstring[]NoResource IDs to keep pending where supported
idempotency_keystringNoOperation key for ack or retry
softbooleanNoStage the draft dormant (active=False) — propose; the ack ({idempotency_key, accept}) promotes/rejects it
acceptbooleanNoAccept or reject dormant state

Response (PatchParameterDraftApiResponse)

FieldTypeRequiredDescription
successbooleanYesWhether the draft save succeeded
draft_idstringYesDraft unique identifier
idempotency_keystringYesIdempotency key for this draft operation
messagestringYesResult message
form_stateapp__infra__parameter__types__DraftFormStateNoServer-authoritative form state
Last updated on