Feature Collections

specstableimplmature

Feature Collections.

Scope

The building block Feature Collections has to be enabled for every API with a feature provider. It provides the resources Feature Collections and Feature Collection. Currently, feature collections are the only supported type of collection.

Info

Additional links for a specific Collection can be defined in the configuration of the collection.

Conformance Classes

Feature Collections implements all requirements of conformance class Core of OGC API - Features - Part 1: Core 1.0.1open in new window for the two mentioned resources.

Operations

ResourcePathMethodsMedia TypesDescription
Feature Collections
collections
GET
HTML, JSON, XML
The dataset is organized in feature collections. This resource provides information about and access to the feature collections. The response contains the list of collections. For each collection, a link to the items in the collection (path /collections/{collectionId}/items, link relation items) as well as key information about the collection.
Feature Collection
collections/{collectionId}
GET
HTML, JSON, XML
Information about the feature collection with id collectionId. The response contains a link to the items in the collection (path /collections/{collectionId}/items,link relation items) as well as key information about the collection.

Path Parameters

NameResourcesDescription
collectionId
Feature Collection
The identifier of the feature collection.

Query Parameters

NameResourcesDescription
f
Collections
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.
f
Collection
Select the output format of the response. If no value is provided, the standard HTTP rules apply, i.e., the "Accept" header will be used to determine the format.

Configuration

Options

NameDefaultDescriptionTypeSince
buildingBlock
Always COLLECTIONS.
string
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1
enabled
true
Enable the building block?
boolean
v3.1
additionalLinks
[]
Add additional links to the Collections resource. The value is an array of link objects. Required properties of a link are a URI (href), a label (label) and a relation (rel).
array
v3.1
collectionIdAsParameter
false
Controls whether each feature collection and subresource is listed as a single resource in the API definition (false), or whether a path parameter collectionId is used and each resource is specified only once in the definition (true). With true the API definition becomes simpler and shorter, but the schema is no longer collection-specific and collection-specific query parameters can no longer be specified in the API definition.
boolean
v3.1
collectionDefinitionsAreIdentical
false
If in the case of collectionIdAsParameter: true all collections have a structurally identical schema and the same queryables, the value true can be used to control that in the API definition schema and queryables are determined from any collection.
boolean
v3.1

Examples


- buildingBlock: COLLECTIONS
  additionalLinks:
  - rel: related
    type: text/html
    title: 'Weinlagen-Online website (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/portal/weinlagen.html'
    hreflang: de
  - rel: related
    type: application/xml
    title: 'OGC Web Map Service with the data (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/cgi-bin/mapserv?map=/data/_map/weinlagen/einzellagen_rlp.map&service=WMS&request=GetCapabilities'
    hreflang: de
  - rel: related
    type: application/xml
    title: 'OGC Web Feature Service with the data (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/geoserver/lwk/ows?service=WFS&request=getcapabilities'
    hreflang: de
  - rel: enclosure
    type: application/x-shape
    title: 'Download the data as a shapefile (Provider: Landwirtschaftskammer Rheinland-Pfalz)'
    href: 'http://weinlagen.lwk-rlp.de/geoserver/lwk/ows?service=WFS&version=1.0.0&request=GetFeature&typeName=lwk:Weinlagen&outputFormat=shape-zip'
    hreflang: de