Skip to Content

POST /scenario/get

Get Scenario

Get scenario information using the canonical shared scenario operation.

Request Body (GetScenarioApiRequest)

FieldTypeRequiredDescription
idstringNoUUID of the scenario to retrieve
draft_idstringNoUUID of the draft
snapshot_keystringNoCache snapshot key for consistent reads across related requests
namesapp__infra__persona__types__SectionFilterNo—
descriptionsapp__infra__persona__types__SectionFilterNo—
problem_statementsapp__infra__persona__types__SectionFilterNo—
flagsapp__infra__persona__types__SectionFilterNo—
departmentsapp__infra__persona__types__SectionFilterNo—
personasapp__infra__persona__types__SectionFilterNo—
documentsapp__infra__persona__types__SectionFilterNo—
parametersapp__infra__persona__types__SectionFilterNo—
parameter_fieldsapp__infra__persona__types__SectionFilterNo—
objectivesapp__infra__persona__types__SectionFilterNo—
imagesapp__infra__persona__types__SectionFilterNo—
videosapp__infra__persona__types__SectionFilterNo—
questionsapp__infra__persona__types__SectionFilterNo—
optionsapp__infra__persona__types__SectionFilterNo—

Response (GetScenarioApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current actor
scenario_existsbooleanNoWhether the scenario exists
can_editbooleanNoWhether the current user can edit
disabled_reasonstringNoReason the scenario is disabled
group_idstringNoUUID of the owning group
draft_namestringNoImmutable draft label from the active draft entry, when a draft_id was supplied. None for non-draft fetches.
show_ai_generatebooleanNoWhether AI generation is available
resolved_parameter_idsstring[]NoResolved parameter IDs from saved fields
namesScenarioNameResource[]NoName resources
descriptionsScenarioDescriptionResource[]NoDescription resources
problem_statementsScenarioProblemStatement[]NoProblem statement resources
flagsScenarioFlagResource[]NoFlag configs
departmentsScenarioDepartment[]NoDepartment resources
personasScenarioPersona[]NoPersona resources
documentsScenarioDocument[]NoDocument resources
parametersany[]NoParameter resources
parameter_fieldsScenarioField[]NoParameter field resources
objectivesScenarioObjective[]NoObjective resources
imagesScenarioImage[]NoImage resources
videosScenarioVideo[]NoVideo resources
questionsScenarioQuestion[]NoQuestion resources
optionsScenarioOption[]NoOption resources
Last updated on