v1
latestOpenAPI 3.0.22026-07-174950145.6 KBGet features with radius search
List the features which are inside the specified radius. The origin radius point is calculated based either on latitude & longitude or by specifying a features geometry. As third option it is possible to use a H3 index as input geometry.
Path parameters
The unique identifier of the space.
Query parameters
The latitude in WGS'84 decimal degree (-90 to +90) of the center Point.
The longitude in WGS'84 decimal degree (-180 to +180) of the center Point.
The space where the feature, referenced by refFeatureId, is stored. Required if refFeatureId is used.
The unique identifier of a feature in the referenced space. The feature's geometry is used as a reference in the spatial search.
H3 index
Radius in meters which defines the diameter of the search request.
The maximum number of features in the response. Default is 30000. Hard limit is 100000.
If set to true the features' geometries are clipped to the geometry of the tile, bounding box or input geometry. Default is false.
Additional feature filters which compare the feature's property value with the one specified in the query, resulting in a subset of features.
The usage of multiple property names represents an AND operation. The usage of a comma (,) separating the properties values, represents an OR operation.
Properties initiated with 'f.' are used to access values which are added by default in the stored feature. The possible values are: 'f.id', 'f.createdAt', 'f.updatedAt'.
Properties initiated with 'p.' are used to access values in the stored feature which are under the 'properties' property. Use it as a shorthand accessor for 'properties' values.
The format should follow the specification below
- ?p.property_name_1=property_value_1&f.special_property_name_1=special_property_value_1
For example, the above query, the Features are filtered by 'property' AND 'special property' equals to their respective values.
While in the following example
- ?p.property_name_1=value_1,value_2
The resulting Features list contains all elements having value_1 OR value_2.
Additionally, to the operators used in the examples above, the query can be written, with the same semantic, by using the long operators: "=gte=", "=lte=", "=gt=", "=lt=" and "=cs=". The following queries yield the same result:
- ?p.property_name_1>=10
- ?p.property_name_1=gte=10
The available operators are:
- "=" - equals
- "!=" - not equals
- "=.null" - is null
- "!=.null" - is not null
- ">=" or "=gte=" - greater than or equals
- "<=" or "=lte=" - less than or equals
- ">" or "=gt=" - greater than
- "<" or "=lt=" - less than
- "@>" or "=cs=" - Array contains
{
"p.myProperty1": "someValue",
"p.myProperty2!": "not-equal",
"p.myNumber1": 5,
"p.myNumber2=gte": 7
}A list of properties to be returned in the features result list. Multiple attributes can be specified by using comma(,).
Example: ?selection=p.name,p.capacity,p.color,rootpropertyname
- !geometry : special value to omit geometries
If set to true the response is not returned from cache. Default is false.
If set to true the features in the response have only X's and Y's as coordinates.
The context where the operation will be performed on a composite space. If not specified, the operation occurs based on the extension rules. For additional information, see Space.extends.
Available context are:
| Context | Description |
|---|---|
| default | The default value if none is given. For composite spaces the operation occurs based on the extension rules. For normal spaces this is the only valid context. |
| extension | The operation will be executed only in the extension and no operation will be performed in the extended space. |
| super | Only applicable for read-operations. The operation will be executed only in the space being extended (super space). |
The query parameter used to specify the version of a feature or feature collection to be loaded.
The query parameter used to specify the target version reference when reading or writing features. A reference describes a target tag or a branch and/or a version within that target branch.
Default is: main:HEAD
<br> Version references have the following syntax: <br> `[<branchName (optional, default: main)>:][<version (optional, default: HEAD)>] | [<tagName> (optional)]` <br> The "main"-branch is pointing to the space itself as it has been created in the first place. Defining the branch as part of the reference only becomes necessary if further branches have been created for the space, which should be addressed by the ref. <br> Depending on the use-case it can be necessary to specify a range of versions rather than only one version. In such a case the version part of the Ref would look like: `<start>..<end>`Where <start> is the start of the range (exclusive) and <end> is the end of the range (inclusive).
Another way of specifying a version range is using the star-symbol: *
Using * refers to "all available versions" in the space or branch and is only applicable in the cases in which a version range may be provided.
<br> Samples: - `main:42` points to version 42 of the "main"-branch - `myTag` points to the version of the tag with ID "myTag" - `myBranch:37` Points to version 37 of the branch with ID "myBranch" - `42` points to version 42 of the "main"-branch - `myBranch:HEAD` points to the latest version of the branch with ID "myBranch" - `HEAD` points to the latest version of the "main"-branch - `myBranch` points to the latest version of the branch with ID "myBranch" - `myBranch:0..HEAD` points to all available versions of the branch with ID "myBranch" - `0..HEAD` also points to all available versions of the "main"-branch - `*` also points to all versions (short form) - `myBranch:*` also points to all versions of branch "myBranch" (short form) - `main:5..10` points to the versions in the interval `]5, 10]` of the "main"-branch - `5..10` also points to the versions in the interval `]5, 10]` of the "main"-branchResponse
An array of features response.