Catalogus opvragen

Label: Catalogus

Endpoint Pre-productie

API voor opvragen catalogus via service.pre.omgevingswet.overheid.nl

Endpoint Productie

API voor opvragen catalogus via service.omgevingswet.overheid.nl

Omschrijving

Met deze API kunnen begrippen worden opgevraagd. Van ieder begrip geeft de API (voor zover relevant) de formele definitie, uitleg in klare taal, bron en gerelateerde begrippen (semantische relatie, generalisatie, specialisatie, onderdeel van, bestaat uit).

Om te kunnen tijdreizen wordt metadata meegegeven:

• de datum waarop het begrip is gepubliceerd
• de datum waarop het begrip uit de lijst met actuele begrippen is gehaald
• de datum waarop het begrip (juridisch) geldig is geworden
• de datum waarop de (juridische) geldigheid vervalt.

Begrippen zijn geordend per domein. Dit domein wordt beschreven als een dataset. Binnen een domein kunnen begrippen worden geordend in collecties.

De datasets worden federatief beheerd door de verschillende bronhouders. Bij iedere dataset wordt aangegeven wie de bronhouder is en daarmee verantwoordelijk is voor de inhoud.

Verbeterd in V3

Vooral de Developer Experience van deze API is met V3 verbeterd, dat wil zeggen dat de endpoints duidelijker zijn geworden en ook de manier waarop resultaten gefilterd kunnen worden, is verbeterd.

De API beschikt nu over de volgende endpoints:

• ConceptSchema’s opvragen (/conceptschemas)
• Collecties opvragen (/collecties)
• Concepten opvragen (/concepten)
• Bronnen opvragen (/bronnen)
• Waardelijsten opvragen (/waardelijsten)
• Informatieproducten opvragen (/informatieproducten)
• Applicatie-eigenschappen opvragen (/info)
• Health status opvragen (/health)
• Applicatie-eigenschappen opvragen (/app-info)
• Health status opvragen (/app-health)
• Activiteiten opvragen (/activiteiten)
• Werkzaamheden opvragen (/werkzaamheden)
• Begrippen opvragen (/begrippen)
• Begrippenkaders opvragen (/begrippenkaders)

Elke endpoint heeft een aantal generieke en specifieke parameters, waardoor het gebruik eenduidiger is geworden.

Met de introductie van de Endpoints /activiteiten, /werkzaamheden en /begrippen kunnen op een eenvoudige manier de concepten van de typen activiteit, werkzaamheid en begrip opgevraagd worden.
Met het Endpoint /begrippenkaders wordt de lijn doorgetrokken om de Endpoints herkenbaarder te maken.

Ook toegevoegd:

• Authenticatie met X-API-KEY-header is toegevoegd aan de specificatie
• Endpoint-urls zijn toegevoegd aan de specificatie

Documentatie

• Beschrijving van de informatie over begrippen, geldigheid/provenance, collecties en datasets (op basis van Best Practices for meaningful connected computing).