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 an OpenSearch index. Composed into request objects (e.g., SearchIndexQuery) that wrap it with context such as which index to target.
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).