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

Download Open API Spec

RangeFieldOptions

org.sagebionetworks.repo.model.search.dsl.RangeFieldOptions

Per-field options for a range term-level clause. Carried as the value of the field-keyed range map (the map key is the column name). Bound values are polymorphic (number, date string, ...) and so are typed as opaque objects.

Field Type Description
boost NUMBER Optional. Multiplier for the relevance score of this clause. Default 1.0.
_name STRING Optional. Label echoed back in matched-queries metadata.
gte OBJECT Optional. Greater-than-or-equal-to bound. A number or date string, per the target column type.
gt OBJECT Optional. Greater-than bound.
lte OBJECT Optional. Less-than-or-equal-to bound.
lt OBJECT Optional. Less-than bound.
format STRING Optional. Date format used to parse the bound values on a date column.
relation STRING Optional. How the range relates to range-typed field values: INTERSECTS (default), CONTAINS, or WITHIN.
time_zone STRING Optional. UTC offset or IANA zone used to interpret date bounds.