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

Download Open API Spec

KeyRange

org.sagebionetworks.repo.model.search.KeyRange

A range filter over one column. Matches rows where the column value falls between min and max, inclusive on both ends. At least one of min or max must be set (omit either bound for an open-ended range). Values are strings and are parsed per the column type: integer / double columns accept numeric literals; date columns accept ISO-8601 strings. Runs in non-scoring context.

Field Type Description
key STRING The column name to filter on. Must be a column present on the SearchIndex's schema.
min STRING Minimum value (inclusive). Omit for an open-ended lower bound. At least one of min / max must be set.
max STRING Maximum value (inclusive). Omit for an open-ended upper bound. At least one of min / max must be set.