The Open API specification for Synapse is now available for download!

Download Open API Spec

SearchIndexQuery

org.sagebionetworks.repo.model.search.table.SearchIndexQuery

Async request to query a SearchIndex entity's OpenSearch index. Identifies the target index and carries the search-request body.

Field Type Description
concreteType STRING
searchIndexId STRING The ID of the SearchIndex entity to query.
searchQuery SearchQuery

The body of an OpenSearch _search request, narrowed to the top-level keys Synapse accepts. Each slot's contents are pass-through OpenSearch query DSL; see the search REST endpoint for the inner-clause allowlist, field-reference rules, pagination semantics, and per-request limits.

responseParts SET<SearchQueryPart> Optional list of additional parts to include in the SearchQueryResults beyond the default HITS + offset. Null or empty means HITS only (the default minimal payload). Requesting parts also drives the corresponding work in OpenSearch (aggregations, total-hit tracking).