Features - Custom Extensions

speccustomimplproposal

POST on /items and filter by geometry intersection.

Scope

The module Features - Custom Extensions adds support for the HTTP method POST on the features resource. The difference to calling with GET is that the query parameters are passed as content in the request. This may be desired for two reasons:

  • URLs are limited in length in HTTP implementations. Extensive filter expressions in GET
    calls are often too long. Using POST gets around this limitation.
  • When using POST, query parameters are transmitted in encrypted form when using HTTPS and are not logged in request
    logs. This may be desirable for security or privacy reasons.

Note that this capability has been deprecated. Instead, use an Ad-hoc Query from Features - Search.

The module further adds support for the following query parameter:

  • intersects: if the parameter is specified, the features are
    additionally selected by the geometry specified as value and only features whose primary
    geometry intersects with the specified geometry are returned. The geometry can be either a
    WKT geometry or a URL for a GeoJSON object with a geometry. In case of a FeatureCollection
    the first geometry is used.

Operations

ResourcePathMethodsMedia TypesDescription
Features
collections/{collectionId}/items
POST
CSV, CityJSON, CityJSON-Seq, FlatGeobuf, GML, GeoJSON, HTML, JSON-FG
The difference to calling with GET is that the query parameters are passed as content in the request.

Path Parameters

NameResourcesDescription
collectionId
Features, Feature
The identifier of the feature collection.

Query Parameters

NameResourcesDescription
intersects
Features
A Well Known Text representation of a geometry as defined in Simple Feature Access - Part 1: Common Architecture or a URI that returns a GeoJSON feature with a geometry. Only features are returned that intersect the geometry.

Configuration

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always FEATURES_EXTENSIONS.
string
v2.0
extensionType
Deprecated See buildingBlock.
string
v2.0
enabled
false
Enable the building block?
boolean
v2.0
postOnItems
false
Deprecated Instead, use an Ad-hoc Query from Features - Search. Enables support for the POST HTTP method on the "Features" resource.
boolean
v3.1
intersectsParameter
false
Enables support for the intersects query parameter on the "Features" resource
boolean
v3.1

Examples

{@examples}