Here is a list of each generic request parameter with a brief description, and the type of endpoints it is available for.
| Parameter | Type | Description | Endpoints |
|---|---|---|---|
_format |
String | Name of a supported content type | All |
{path} |
Any | Exact value filter or encoded range | List |
min-{path} |
Any | Minimum value filter | List |
mineq-{path} |
Any | Minimum or equal value filter | List |
max-{path} |
Any | Maximum value filter | List |
maxeq-{path} |
Any | Maximum or equal value filter | List |
exists-{path} |
Boolean | Value existence filter | List |
_sort |
String | Sort on a path | List |
_limit |
Integer | Result limit | List |
_offset |
Integer | Result offset | List |
_view |
String | Name of a view | List, Item |
_projection |
String | Projection on view | List, Item |
_withView |
Boolean | With _projection, includes the original view in the new projection |
List, Item |
_metadata |
Boolean | Whether to include metadata in JSON and TTL results | List, Item |
_includeId |
Boolean | Whether to include a root ID column (@id) in the CSV or XLS response (does not affect other formats). |
All |
{variable} |
Any | Bind template variable | List, Template |
search |
String | Text search term(s) | List |
fuzzy |
None | Fuzzy text search flag | List |
raw-search |
None | Raw text search flag | List |
searchPath |
String | Path to subject of the text search | List |
search-{prop} |
String | Text search term(s) for the given property. | List |
_groupBy |
String | Group by the values of the given path | List |
_count |
String | Perform a count on values of the given path | List |
easting |
Decimal | OS easting of geo point | List |
northing |
Decimal | OS northing of geo point | List |
lat |
Decimal | Latitude of geo point | List |
long |
Decimal | Longitude of geo point | List |
dist |
Decimal | Filter by distance from geo point | List |
within |
JSON | Filter by bounds of the given polygon | List |
with-geometry |
Boolean | Include associated geometry in response | Item, List |