Scenario Search

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Either userId or zoeId must be provided to scope the search.

string
required

Free-text query to search for across supported fields.

integer
required
≥ 0

Zero-based page index.

integer
required
≥ 1

Number of items per page.

filters
array

Optional list of filters applied with AND semantics. null is treated as an empty list.

Filters
ScenarioSearchSortFDTO | null

Optional sort specification.

includeFields
array of strings

Optional whitelist of fields to include in each item. Use * to return all fields, which can be helpful for exploring available fields. null is treated as an empty list.

Includefields
array | null

Ordered facet selection for this request. A supplied array selects facets instead of the server's default facet strategy; omission or null uses that strategy and its ordering. An empty array requests no primary facets and overrides that strategy; available facets are still returned. Additional facets for unselected filtered fields remain available even with an empty selection or empty defaults, and even without *. Facets may include optional local min/max and query-wide globalMin/globalMax statistics when available. Selection is not an exclusive response-field allowlist: additional valid facets can still be returned, regardless of selection. facetCounts is empty only when no facets are available. Names use ASCII alphanumeric segments separated by dots, without whitespace or underscores. A standalone * is allowed once, only as the final entry. Duplicate explicit names are rejected; names are case-sensitive. Invalid values return HTTP 422. Present explicit fields appear first in selection order, then remaining filtered fields in first occurrence order in the filters array, then remaining facets, including wildcard facets, in existing relative order. Each field appears at most once; selection takes precedence for fields that are also filtered. Missing fields have no placeholders. Facet bucket order and public field/type rules remain unchanged.

Optional logged-in user identifier to scope the search. Either userId or zoeId must be provided.

Optional anonymous user identifier to scope the search. The field name zoeId is retained for API compatibility. Either userId or zoeId must be provided.

Optional Search Model Runtime selector. A non-empty request value overrides scenario configuration; null or an empty string defers to scenario configuration.

Optional scenario inside the selected Search Model Runtime container, separate from scenarioId. A non-empty request value overrides configured searchModelScenario; omission, null, or an empty string uses configuration, then query-router. Values are opaque, case-sensitive, and untrimmed. An effective searchModel is required to activate runtime routing.

object | null

Request-only Runtime configuration override. Omission or null preserves deployed configuration; an empty object selects Runtime defaults. Partial objects replace runtime configuration and use Runtime defaults for unspecified knobs. Validation belongs to the selected Runtime.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain