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 parameters.

Field Type Description
concreteType STRING
searchIndexId STRING The ID of the SearchIndex entity to query.
searchQuery SearchQuery A structured search query against a Synapse SearchIndex, composed of a main full-text query, zero or more structured filters, optional facet aggregations, and response-shaping options (sort, highlight, pagination). Most callers will set at least queryText (or leave it empty for a catalog-style MATCH_ALL browse) and possibly queryType + queryFields. Filters, facets, sort, and returnFields are independent layers — any combination is valid. Filters run in non-scoring context: they narrow the result set without influencing relevance.
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).