Codelists

speccustomimplproposal

Publish codelists associated with feature properties.

Scope

If the schema of a feature type includes "codelist" constraints and this building block is enabled, the codelists can be accessed via the API in HTML and JSON.

Operations

ResourcePathMethodsMedia TypesDescription
Codelists
codelists
GET
This operation fetches the codelists available for this API.
Codelist
codelists/{codelistId}
GET
Fetches the codeliste with identifier codelistId. The set of available codelists can be retrieved at codelists.

Path Parameters

NameResourcesDescription
codelistId
Codelist
The local identifier of the codelist.

Query Parameters

NameResourcesDescription
f
Codelists
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
Codelist
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 CODELISTS.
string
v3.1
enabled
false
Enable the building block?
boolean
v3.1
caching
{}
Sets fixed values for HTTP Caching Headers for the resources.
object
v3.1

Examples


- buildingBlock: CODELISTS
  enabled: true