Skip to Content

POST /scenario/draft

Patch Scenario Draft

Patch scenario draft — composable infra architecture.

Request Body (PatchScenarioDraftApiRequest)

FieldTypeRequiredDescription
input_draft_idstringNoUUID of the input draft
namestringNoDisplay name value
name_idstringNoUUID of the name resource
descriptionstringNoDescription text value
description_idstringNoUUID of the description resource
problem_statementstringNoProblem statement text value
problem_statement_idstringNoUUID of the problem statement resource
objectivesstring[]NoObjective texts to create
objective_idsstring[]NoExisting objective UUIDs
imagesapp__infra__scenario__types__DraftImageValue[]NoImage values to create
image_idsstring[]NoExisting image UUIDs
videosapp__infra__scenario__types__DraftVideoValue[]NoVideo values to create
video_idsstring[]NoExisting video UUIDs
questionsapp__infra__scenario__types__DraftQuestionValue[]NoQuestion values to create
question_idsstring[]NoExisting question UUIDs
optionsapp__infra__scenario__types__DraftOptionValue[]NoOption values to create
option_idsstring[]NoExisting option UUIDs
flag_idsstring[]NoSelected flag option UUIDs — canonical; server derives semantics by flag type/value
activebooleanNoDenormalized scenario_active flag state
video_enabledbooleanNoDenormalized video_enabled flag state
problem_statement_enabledbooleanNoDenormalized problem_statement_enabled flag state
objectives_enabledbooleanNoDenormalized objectives_enabled flag state
images_enabledbooleanNoDenormalized images_enabled flag state
questions_enabledbooleanNoDenormalized questions_enabled flag state
department_idsstring[]NoAssociated department UUIDs
persona_idsstring[]NoAssociated persona UUIDs
document_idsstring[]NoAssociated document UUIDs
parameter_field_idsstring[]NoAssociated parameter field UUIDs
pending_idsstring[]NoResource IDs to keep as pending (active=false on connection)
idempotency_keystringNoOperation key for ack — promotes or rejects a dormant draft
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 (PatchScenarioDraftApiResponse)

FieldTypeRequiredDescription
successbooleanYesWhether the operation succeeded
draft_idstringYesUUID of the saved draft
idempotency_keystringYesIdempotency key for this draft operation (same as draft entry ID)
messagestringYesHuman-readable result message
form_stateScenarioDraftFormStateYesServer-authoritative form state
Last updated on