Codelists
speccustomimplproposalVeröffentlichung von Codelisten, die mit Feature-Eigenschaften verbunden sind.
Umfang
Wenn das Schema einer Objektart "codelist"-Constraints enthält und dieser Baustein aktiviert ist, kann auf die Codelisten über die API in HTML und JSON zugegriffen werden.
Operationen
| Ressource | Pfad | Methoden | Formate | Beschreibung |
|---|---|---|---|---|
Codelists | codelists | GET | HTML, JSON | Die Operation ruft die Codelisten in der API ab. |
Codelist | codelists/{codelistId} | GET | HTML, JSON | Holt die Codelist mit dem Bezeichner codelistId. Die Menge der verfügbaren Codelisten kann unter codelists abgerufen werden. |
Pfad-Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
codelistId | Codelist | Der lokale Identifikator der Codeliste. |
Query Parameter
| Name | Ressourcen | Beschreibung |
|---|---|---|
f | Codelists | Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet. |
f | Codelist | Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet. |
Konfiguration
Optionen
| Name | Default | Beschreibung | Typ | Seit |
|---|---|---|---|---|
buildingBlock | Immer CODELISTS. | string | v3.1 | |
enabled | false | Soll der Baustein aktiviert werden? | boolean | v3.1 |
caching | {} | Setzt feste Werte für HTTP-Caching-Header für die Ressourcen. | object | v3.1 |
Beispiele
- buildingBlock: CODELISTS
enabled: true