Codelists
speccustomimplproposalPublish 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
| Resource | Path | Methods | Media Types | Description |
|---|---|---|---|---|
Codelists | codelists | GET | HTML, JSON | This operation fetches the codelists available for this API. |
Codelist | codelists/{codelistId} | GET | HTML, JSON | Fetches the codeliste with identifier codelistId. The set of available codelists can be retrieved at codelists. |
Path Parameters
| Name | Resources | Description |
|---|---|---|
codelistId | Codelist | The local identifier of the codelist. |
Query Parameters
| Name | Resources | Description |
|---|---|---|
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
| Name | Default | Description | Type | Since |
|---|---|---|---|---|
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