{
"openapi": "3.0.0",
"info": {
"title": "Omgevingsdocument downloaden",
"description": "Met deze REST API kan een regelingversie van een Omgevingsdocument in een zip-bestand worden gedownload met daarin de juridische tekst, de GIO's en de OW-objecten. Ook is het mogelijk voor een lijst locaties de geometrieën in GeoPackage-formaat (GPKG) op te vragen.\n
De Omgevingsdocumenten Download API volgt de standaarden zoals beschreven in de DSO API-strategie versie 2.0. \n
De Omgevingsdocumenten Download API levert informatie conform de STOP/TPOD-standaard, in het bijzonder het Conceptueel Informatiemodel Omgevingswet.\n
Meer informatie is hier te vinden: https://www.geonovum.nl/omgevingswet/STOPTPOD\n",
"termsOfService": "https://developer.omgevingswet.overheid.nl/services/fair-use-policy/",
"contact": {
"name": "Kadaster DSO - Team Ozon",
"url": "https://developer.omgevingswet.overheid.nl/services/contact/"
},
"version": "1.9.2"
},
"externalDocs": {
"url": "https://developer.omgevingswet.overheid.nl/api-register/api/omgevingsdocument-downloaden/"
},
"servers": [
{
"url": "/publiek/omgevingsdocumenten/api/downloaden/v1",
"description": "de API op deze server"
},
{
"url": "https://service.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/downloaden/v1",
"description": "de API op de productieomgeving van DSO-LV"
},
{
"url": "https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/downloaden/v1",
"description": "de API op de pre-productieomgeving van DSO-LV"
}
],
"security": [
{
"apiKey": []
}
],
"tags": [
{
"name": "Downloaden regeling (zip)",
"description": "Downloaden van een zip met daarin de OW en OP informatie van een gepubliceerde regeling"
},
{
"name": "Downloaden ontwerp regeling (zip)",
"description": "Downloaden van een zip met daarin de OW en OP informatie van een ontwerpregeling"
},
{
"name": "Downloaden geometrie (geopackage)",
"description": "Downloaden van een geopackage met geometrieen."
},
{
"name": "Meta",
"description": "Operaties die niet domeinspecifiek zijn, maar over de applicatie gaan."
}
],
"paths": {
"/aanvraag": {
"post": {
"tags": [
"Downloaden regeling (zip)"
],
"summary": "Plaats een verzoek voor het maken van een download uitwisselpakket zip.",
"operationId": "postAanvraag",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AanvraagVerzoek"
},
"examples": {
"workIdActueel": {
"value": {
"regelingId": "/akn/nl/act/mnre1034/2020/regOW01"
}
},
"workIdOpDatum": {
"value": {
"regelingId": "/akn/nl/act/mnre1034/2020/regOW01",
"juridischGeldigOp": "2023-06-01"
}
},
"expressionActueel": {
"value": {
"regelingId": "/akn/nl/act/gm0059/2020/omgevingsplan/nld@1-0"
}
},
"expressionOpDatum": {
"value": {
"regelingId": "/akn/nl/act/gm0059/2020/omgevingsplan/nld@1-0",
"juridischGeldigOp": "2023-05-01"
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Verzoek geaccepteerd",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AanvraagRespons"
}
}
}
},
"400": {
"description": "Het request bevat onjuiste of ongeldige gegevens, bijvoorbeeld een verkeerde datum.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "Er kan geen regeling of toestand gevonden worden die voldoet aan het AanvraagVerzoek.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/ontwerp_aanvraag": {
"post": {
"tags": [
"Downloaden ontwerp regeling (zip)"
],
"summary": "Plaats een verzoek voor het maken van een ontwerp download uitwisselpakket zip.",
"operationId": "postOntwerpAanvraag",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OntwerpAanvraagVerzoek"
}
}
}
},
"responses": {
"202": {
"description": "Verzoek geaccepteerd",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AanvraagRespons"
}
}
}
},
"400": {
"description": "Het request bevat onjuiste of ongeldige gegevens, bijvoorbeeld een verkeerde datum.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "Er kan geen regeling of toestand gevonden worden die voldoet aan het AanvraagVerzoek.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/status/{verzoekIdentificatie}": {
"get": {
"tags": [
"Downloaden regeling (zip)",
"Downloaden ontwerp regeling (zip)"
],
"summary": "Vraag de status op van het download proces.",
"operationId": "getStatus",
"parameters": [
{
"name": "verzoekIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
],
"responses": {
"200": {
"description": "De status bij deze VerzoekIdentificatie is bekend.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusRespons"
}
}
}
},
"404": {
"description": "De status bij deze VerzoekIdentificatie is onbekend.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/teruglevering/{verzoekIdentificatie}": {
"get": {
"tags": [
"Downloaden regeling (zip)",
"Downloaden ontwerp regeling (zip)"
],
"summary": "Haal de url naar de te downloaden zip op. Vanwege deprecation wordt geadviseerd om '/download/{verzoekIdentificatie}' te gebruiken.",
"operationId": "getTeruglevering",
"parameters": [
{
"name": "verzoekIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
],
"responses": {
"200": {
"description": "De download ZIP is beschikbaar.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadRespons"
}
}
}
},
"410": {
"description": "De download zip was beschikbaar, maar is verwijderd. Plaats een nieuw verzoek.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "de download ZIP is niet beschikbaar.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/download/{verzoekIdentificatie}": {
"get": {
"tags": [
"Downloaden regeling (zip)",
"Downloaden ontwerp regeling (zip)"
],
"summary": "Haal de url naar de te downloaden zip op.",
"operationId": "getDownload",
"parameters": [
{
"name": "verzoekIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
],
"responses": {
"200": {
"description": "De download ZIP is beschikbaar.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadRespons"
}
}
}
},
"404": {
"description": "de download ZIP is niet beschikbaar.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"410": {
"description": "De download zip was beschikbaar, maar is verwijderd. Plaats een nieuw verzoek.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/geometrie/aanvraag": {
"post": {
"tags": [
"Downloaden geometrie (geopackage)"
],
"summary": "Plaats een verzoek voor het maken van een geopackage met daarin de opgevraagde geometrieen.",
"operationId": "postGeometrieAanvraag",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeometrieAanvraagVerzoek"
},
"examples": {
"locatiesActueel": {
"value": {
"locatieidentificaties": [
"nl.imow-mnre1034.ambtsgebied.LND6030A",
"nl.imow-mnre1034.ambtsgebied.LND6030B"
]
}
},
"locatiesMetTijdreis": {
"value": {
"locatieidentificaties": [
"nl.imow-mnre1034.ambtsgebied.LND6030A",
"nl.imow-mnre1034.ambtsgebied.LND6030B"
],
"juridischGeldigOp": "2023-06-01",
"beschikbaarOp": "2023-07-07T11:34:01Z"
}
}
}
}
}
},
"responses": {
"202": {
"description": "Verzoek geaccepteerd",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeometrieAanvraagRespons"
}
}
}
},
"400": {
"description": "Het request bevat fouten, bijvoorbeeld fouten in de json syntax.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"422": {
"description": "Het request bevat locatieidentificaties die niet voldoen aan het patroon.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/geometrie/status/{verzoekIdentificatie}": {
"get": {
"tags": [
"Downloaden geometrie (geopackage)"
],
"summary": "Vraag de status op van een te genereren geopackage.",
"operationId": "getGeometrieStatus",
"parameters": [
{
"name": "verzoekIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
],
"responses": {
"200": {
"description": "De status bij deze VerzoekIdentificatie is bekend.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusRespons"
}
}
}
},
"404": {
"description": "De status bij deze VerzoekIdentificatie is onbekend.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/geometrie/geopackage/{verzoekIdentificatie}": {
"get": {
"tags": [
"Downloaden geometrie (geopackage)"
],
"summary": "Haal de url naar de te downloaden geopackage op.",
"operationId": "getGeopackageUrl",
"parameters": [
{
"name": "verzoekIdentificatie",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
],
"responses": {
"200": {
"description": "De geopackage is beschikbaar.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadRespons"
}
}
}
},
"410": {
"description": "De geopackage was beschikbaar, maar is verwijderd. Plaats een nieuw verzoek.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"404": {
"description": "De geopackage is niet beschikbaar.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/geopackages/{geopackageFile}": {
"get": {
"tags": [
"Downloaden geometrie (geopackage)"
],
"summary": "Haal het geopackage op.",
"operationId": "getGeopackage",
"parameters": [
{
"name": "geopackageFile",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Het geopackage bestand",
"content": {
"application/geopackage+sqlite3": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"404": {
"description": "Het geopackage bestand bestaat niet",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/health": {
"get": {
"tags": [
"Meta"
],
"summary": "Dit endpoint levert health informatie uit, maar volgt niet de DSO API-strategie en is daarom deprecated met /app-health als vervanger.",
"operationId": "getHealth",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HealthResponse"
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
},
"deprecated": true
}
},
"/app-health": {
"get": {
"tags": [
"Meta"
],
"summary": "app-health info",
"operationId": "getAppHealth",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppHealthResponse"
},
"example": {
"app-health": {
"status": "UP"
}
}
}
}
},
"503": {
"description": "Service unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppHealthResponse"
},
"example": {
"app-health": {
"status": "DOWN"
}
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/app-info": {
"get": {
"tags": [
"Meta"
],
"summary": "applicatie info",
"operationId": "getInfo",
"responses": {
"200": {
"description": "Info",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Info"
}
}
}
}
}
}
},
"/openapi.yaml": {
"get": {
"x-auth-type": "None",
"tags": [
"Meta"
],
"summary": "De OpenAPI specificatie in YAML-formaat",
"description": "Vraag de OpenAPI specificatie op in YAML formaat.",
"operationId": "getOpenApiYaml",
"responses": {
"200": {
"description": "OK",
"content": {
"application/yaml": {
"schema": {
"title": "OpenApiSchemaYaml",
"type": "object",
"description": "Het YAML schema van de OpenAPI specificatie."
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/openapi.json": {
"get": {
"x-auth-type": "None",
"tags": [
"Meta"
],
"summary": "De OpenAPI specificatie in JSON-formaat",
"description": "Vraag de OpenAPI specificatie op in JSON formaat.",
"operationId": "getOpenApiJson",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"title": "OpenApiSchemaJson",
"type": "object",
"description": "Het JSON schema van de OpenAPI specificatie."
}
}
}
},
"default": {
"description": "Onverwacht probleem",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}
},
"/download_uitwisselpakket/{bestandsnaamUitwisselpakket}": {
"get": {
"tags": [
"Downloaden regeling (zip)"
],
"summary": "Haal de zip op voor het uitwisselpakket",
"description": "Haal de zip op voor het uitwisselpakket.",
"operationId": "downloadUitwisselpakket",
"parameters": [
{
"name": "bestandsnaamUitwisselpakket",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/BestandsnaamUitwisselpakket"
}
}
],
"responses": {
"200": {
"description": "Haal de zip op voor het uitwisselpakket"
}
}
}
},
"/ontwerp_download_uitwisselpakket/{bestandsnaamUitwisselpakket}": {
"get": {
"tags": [
"Downloaden ontwerp regeling (zip)"
],
"summary": "Haal de zip op voor het ontwerp uitwisselpakket",
"description": "Haal de zip op voor het ontwerp uitwisselpakket",
"operationId": "ontwerpDownloadUitwisselpakket",
"parameters": [
{
"name": "bestandsnaamUitwisselpakket",
"in": "path",
"required": true,
"style": "simple",
"explode": false,
"schema": {
"$ref": "#/components/schemas/BestandsnaamUitwisselpakket"
}
}
],
"responses": {
"200": {
"description": "Haal de zip op voor het ontwerp uitwisselpakket."
}
}
}
}
},
"components": {
"schemas": {
"AanvraagVerzoek": {
"required": [
"regelingId"
],
"properties": {
"regelingId": {
"type": "string",
"description": "De identificatie (WorkID) van de regeling, of een identificatie van toestand (Expression)."
},
"juridischGeldigOp": {
"type": "string",
"description": "Een tijdreisparameter langs de juridische-werking-tijdsas. Deze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\n",
"format": "date",
"example": "2023-06-01"
}
},
"description": "Het verzoek om een zip op te bouwen met de laatst bekende gegevens van de regeling met het genoemde regelingId (WorkId).\n"
},
"AanvraagRespons": {
"required": [
"verzoekIdentificatie"
],
"properties": {
"verzoekIdentificatie": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
},
"OntwerpAanvraagVerzoek": {
"required": [
"ontwerpBesluitIdentificatie",
"regelingId"
],
"properties": {
"ontwerpBesluitIdentificatie": {
"type": "string",
"description": "Het OntwerpBesluitIdentificatie"
},
"regelingId": {
"type": "string",
"description": "De identificatie (WorkID) van de regeling."
}
},
"description": "Het verzoek om een ontwerp zip op te bouwen met de laatst bekende gegevens van de regeling met het genoemde regelingId (WorkId) en OntwerpBesluitIdentificatie.\n"
},
"GeometrieAanvraagVerzoek": {
"required": [
"locatieidentificaties"
],
"properties": {
"locatieidentificaties": {
"type": "array",
"description": "De identificaties van de locaties waarmee de geometrie gezocht wordt. bij een verzoek met locatiegroep identificaties zullen de onderliggende locatiegroepitems *niet* in de resulterende geopackage zitten.",
"items": {
"pattern": "^nl.imow-(gm|pv|ws|mn|mnre)[0-9]{1,6}\\.(gebied|gebiedengroep|lijn|lijnengroep|punt|puntengroep|ambtsgebied)\\.[A-Za-z0-9]{1,32}$",
"maxItems": 100,
"minItems": 1,
"type": "string"
}
},
"juridischGeldigOp": {
"type": "string",
"description": "Een tijdreisparameter langs de juridische-werking-tijdsas. Deze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\n",
"format": "date",
"example": "2023-06-01"
},
"beschikbaarOp": {
"type": "string",
"description": "Een tijdreisparameter langs de 'beschikbaar'-tijdsas. **Let op de tijdzone!** Deze tijdreis toont de versie van het object die op de opgegeven datum juridisch in werking is. Wanneer deze parameter niet opgegeven wordt, dan wordt een tijdreisvraag gesteld met als parameter 'vandaag'.\n",
"format": "date-time",
"example": "2022-07-07T11:34:01Z"
}
},
"description": "Het verzoek om een geopackage op te bouwen met de opgegeven locatieidentificaties en tijdreis gegevens.\n"
},
"GeometrieAanvraagRespons": {
"required": [
"verzoekIdentificatie"
],
"properties": {
"verzoekIdentificatie": {
"$ref": "#/components/schemas/VerzoekIdentificatie"
}
}
},
"VerzoekIdentificatie": {
"type": "string",
"description": "Identificatie van het verzoek. Deze identificatie ontvang je als antwoord op een (Geometrie)AanvraagVerzoek en kan gebruikt worden om de status op te vragen en om de URL van het gegenereerde bestand op te vragen.\n",
"format": "uuid",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"BestandsnaamUitwisselpakket": {
"type": "string",
"description": "Gegenereerde naam van het uitwisselpakket. Dit bestaat uit de verzoekIdentificatie en een datum/tijd stempel.\n",
"example": "123e4567-e89b-12d3-a456-426614174000_20251209-0926182.zip"
},
"StatusRespons": {
"required": [
"status"
],
"properties": {
"status": {
"$ref": "#/components/schemas/Status"
},
"code": {
"type": "string",
"description": "Een foutcode indien er meldingen zijn"
},
"omschrijving": {
"type": "string",
"description": "Een omschrijving van de geconstateerde fout"
}
}
},
"Status": {
"type": "string",
"description": "De status van de aanvraag",
"enum": [
"BESCHIKBAAR",
"IN_BEHANDELING",
"MISLUKT"
]
},
"DownloadRespons": {
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"format": "url",
"example": "https://service.pre.omgevingswet.overheid.nl/publiek/omgevingsdocumenten/api/downloaden/v1/download_uitwisselpakket/123e4567-e89b-12d3-a456-426614174000_20251209-0926182.zip"
}
},
"description": "De respons van de download. Deze bevat een url naar de te downloaden zip."
},
"HealthResponse": {
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/AppHealthStatus"
}
}
},
"AppHealthResponse": {
"title": "AppHealthResponse",
"required": [
"app-health"
],
"type": "object",
"properties": {
"app-health": {
"title": "AppHealth",
"required": [
"status"
],
"type": "object",
"properties": {
"status": {
"$ref": "#/components/schemas/AppHealthStatus"
}
}
}
}
},
"AppHealthStatus": {
"type": "string",
"enum": [
"UP",
"DOWN"
]
},
"Info": {
"required": [
"app"
],
"type": "object",
"properties": {
"app": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"version": {
"type": "string"
},
"description": {
"type": "string"
},
"stopVersion": {
"type": "string"
},
"imowVersion": {
"type": "string"
},
"imopVersion": {
"type": "string"
}
}
}
},
"description": "Info"
},
"Problem": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Absolute URI dat het probleemtype identificeert.",
"format": "uri"
},
"title": {
"type": "string",
"description": "Een korte samenvatting van het probleemtype bedoeld voor ontwikkelaars."
},
"status": {
"maximum": 600,
"exclusiveMaximum": true,
"minimum": 100,
"type": "integer",
"description": "De HTTP statuscode gegenereerd door de server waar het probleem zich voordoet.",
"format": "int32",
"example": 500
},
"detail": {
"type": "string",
"description": "Mens-leesbare uitleg van dit specifieke probleem.",
"example": "Interne server fout"
},
"instance": {
"type": "string",
"description": "Absolute URI dat dit specifieke probleem identificeert.",
"format": "uri"
}
},
"description": "Standaardformaat (`application/problem+json`) voor probleemdetails in HTTP API's (RFC 7807)."
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"description": "De API-key die je hebt gekregen dient bij elke request naar de\nAPI via de `x-api-key` request header meegestuurd te worden. Indien deze\nniet juist wordt meegestuurd, of het een ongeldige key betreft, zul je de\nfoutmelding `403 Forbidden` terugkrijgen.\n",
"name": "x-api-key",
"in": "header"
}
}
}
}