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

Download Open API Spec

SearchResults

org.sagebionetworks.repo.model.search.SearchResults

JSON schema for a the result of a search.

Field Type Description
found INTEGER The total number of hits found for this search.
start INTEGER The zero-based number of the first hit returned in this page of search results.
matchExpression STRING DEPRECATED: The search match expression parsed from the search request parameters. This is useful for debugging purposes.
hits ARRAY<Hit> The hits in this page of search results
facets ARRAY<Facet> The facets found in all results of this search.