Search feature by bounds
​
Description
Get information on features within a tile of a vector layer.
Endpoint
/path/{pathId}/vector/layer/{layerId}/featuresByBounds
Method
GET

Access Level Rules

Access Level
view

Processing Units

Processing units
5

Parameters

Name
Description
Required
Default
pathId
The id of the vector block.
true
​
layerId
The id of the vector layer to get features for.
true
​
bounds
An object with required properties 'xMin', 'xMax', 'yMin' and 'yMax' denotating the longitude and latitude bounds of the features to retrieve.
false
Default null.
returnType
The type of information to return. Must be one of 'id', 'count', 'geometry', 'center', 'metadata' or 'all'.
false
Default 'all'.
pageStart
Object containing required property 'featureId' and conditional required property 'value' determining where to start the search of results. 'featureId' determines the featureId from on which to search for results and value determines the property value from on which to search when an inequality is used in the propertyFilter.
false
Default null.
pageSize
The maximum number of features to return. Maximum 3000.
false
Default 3000.
maxSize
The maximum size of data in MB to return. The size of the returned data is an estimation and may differ from the actual returned size. Maximum 8 MB.
false
Default 8 MB.
styleId
The id of the style to apply.
false
Default null.
style
Object containing the properties 'method' and 'parameters' describing the method and parameters of the style to apply.
false
Default null.
zipTheResponse
Boolean whether the result should be zipped.
false
Default false.
propertyFilter
Array of filters use on the properties of the features.
Each entry must be an object with required properties 'key' and 'value' and optional property 'operator', where 'key' is the name of the property, 'value' is the value of the property and 'operator' is the operator to filter by and must be one of '=', '!=', '<', '<=', '>' or '>=' with default '='.
Properties used to filter must be designated beforehand as filter properties. At most two filters can be used at once, one of which must then contain the id property with an '=' operator.
false
Default null.