Search feature by extent

Description	Get information on features within a geographic extent of a vector layer.
Endpoint	/path/{pathId}/vector/timestamp/{timestampId}/featuresByExtent
Method	GET

Access Level Rules

Access Level

view

Processing Units

Processing units

5

Parameters

Name	Description	Required	Default
pathId	The id of the vector layer.	true
timestampId	The id of the timestamp to get features for.	true
bounds	A JSON with required properties "xMin", "xMax", "yMin" and "yMax" denotating the longitude and latitude bounds of the features to retrieve.	false	Default null.
returnType	A string with the type of information to return. Must be one of "id", "count", "geometry", "center", "properties" or "all".	false	Default "all".
pageStart	JSON 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 condition is used in the propertyFilter parmeter.	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.
style	Either a style id or an object describing the desired style. You can find allowed style objects here: https://docs.ellipsis-drive.com/developers/api-v3/path-vector/styles/add-style	false	Default null.
zipTheResponse	Boolean whether the result should be zipped.	false	Default false.
propertyFilter	Array of filters to use on the properties of the features. Each entry must be a JSON with required properties "property" and "value" and optional property "operator", where "property" is the name of the property to filter on, "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, with at most one not '=' operator.	false	Default null.
applyStyle	Boolean indicating whether to style the features or leave the styling to the client.	false	Default true.