Skip to Content

POST /scenario/search

Search Scenario

Search scenarios — composable infra architecture.

Request Body (SearchScenarioApiRequest)

FieldTypeRequiredDescription
searchstringNo
persona_idsstring[]No
simulation_idsstring[]No
filter_department_idsstring[]No
persona_searchstringNo
simulation_searchstringNo
department_searchstringNo
flag_searchstringNo
page_sizeintegerNo
page_offsetintegerNo
snapshot_keystringNoCache snapshot key for consistent reads across related requests

Response (ListScenarioApiResponse)

FieldTypeRequiredDescription
actor_namestringNoDisplay name of the current actor
scenariosListScenarioApiScenario[]NoList of scenario items
objectivesListScenarioApiObjective[]NoList of objective items
fieldsListScenarioApiField[]NoList of field items
cohortsListScenarioApiCohort[]NoList of cohort items
personasListScenarioApiPersona[]NoList of persona items
simulationsListScenarioApiSimulation[]NoList of simulation items
departmentsListScenarioApiDepartment[]NoList of department items
persona_filterListFilterSectionNoFilter options for personas
simulation_filterListFilterSectionNoFilter options for simulations
department_filterListFilterSectionNoFilter options for departments
flag_filterListFilterSectionNoFilter options for flags
total_countintegerNoTotal number of matching records
import_fieldsImportField[]NoCSV import column schema for the bulk-import dialog
Last updated on