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

Download Open API Spec

SearchQuery

org.sagebionetworks.repo.model.search.SearchQuery

A structured search query against an OpenSearch index. Can be submitted as an asynchronous job.

Field Type Description
concreteType STRING
queryType SearchQueryType The type of full-text query to execute against a search index.
queryText STRING The search text. Null or empty matches all documents.
queryFields ARRAY<STRING> Column names with optional boost (e.g., 'studyName^3'). Empty means all indexed fields.
termsFilters ARRAY<KeyValues> Multi-value filters (IN clause).
rangeFilters ARRAY<KeyRange> Range filters with min and max.
existsFilters ARRAY<STRING> Columns that must have a non-null value.
notExistsFilters ARRAY<STRING> Columns that must be null or missing.
fuzziness STRING Typo tolerance: 'AUTO', '0', '1', or '2'.
facetRequests ARRAY<FacetRequest> Columns to aggregate as facets.
returnFields ARRAY<STRING> Columns to include in results. Empty means all columns.
sort ARRAY<SortField> Sort order. Default: relevance descending.
highlight BOOLEAN Whether to return highlighted snippets. Default: false.
offset INTEGER Zero-based pagination offset. Default: 0.
limit INTEGER Results per page. Default: 25. Max: 100.