document | Schema-register

Document metadata van een omgevingsdocument of IMR0-document.

dialect2020-12

typeobject

health58%

dependencies11

Schema gebruiken

JSON Schema

schema.json Download bundled

SourceMeta

SourceMeta name: document
Base dialect: https://json-schema.org/draft/2020-12/schema
SourceMeta dialect: https://json-schema.org/draft/2020-12/schema
Bytes: 5.144 bytes
Bytes bundled: 49.187 bytes
Health: 58%
Dependencies: 11

Dependencies

To: hallinks
At: /properties/_links/$ref

To: bevoegdgezag
At: /properties/aangeleverdDoorEen/$ref

To: imrodocumentmetadata
At: /properties/imroDocumentMetadata/$ref

To: omgevingsdocumentmetadata
At: /properties/omgevingsdocumentMetadata/$ref

To: hallink
At: /additionalProperties/$ref
From: hallinks

To: bekendmaking
At: /properties/bekendmakingen/items/$ref
From: imrodocumentmetadata

To: documentversie
At: /properties/gerelateerdeVersies/items/$ref
From: imrodocumentmetadata

To: onderdeel
At: /properties/onderdelen/items/$ref
From: imrodocumentmetadata

To: planondergrond
At: /properties/ondergronden/items/$ref
From: imrodocumentmetadata

To: planstatusinfo
At: /properties/planstatusInfo/$ref
From: imrodocumentmetadata

To: objectgerichtetekst
At: /properties/objectgerichteTeksten/items/$ref
From: onderdeel

Health issues

Name: top_level_title
Message: Set a concise non-empty title at the top level of the schema to explain what the definition is about
Pointers

Name: top_level_examples
Message: Set a non-empty examples array at the top level of the schema to illustrate the expected data
Pointers

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /description

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/geometrieIdentificaties/description

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/heeftVectorTiles/description

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/identificatie/description

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/titel/description

Name: enum_with_type
Message: Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types
Pointers: /properties/type/enum - /properties/type/type

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/type/description

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/uriIdentificatie/description

Name: non_applicable_type_specific_keywords
Message: Avoid keywords that don't apply to the type or types that the current subschema expects
Pointers: /properties/versie/format

Name: description_trailing_period
Message: Descriptions should not end with a period to give user interfaces flexibility in presenting the text
Pointers: /properties/versie/description

Name: unknown_format_prefix
Message: For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification
Pointers: /properties/versie/format

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/omgevingsinformatie-ontsluiten-api-ow7p61mdg/document",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Document metadata van een omgevingsdocument of IMR0-document.",
  "properties": {
    "_links": {
      "$ref": "./hallinks"
    },
    "aangeleverdDoorEen": {
      "$ref": "./bevoegdgezag"
    },
    "beschikbaarTot": {
      "description": "Tijdstip dat aangeeft tot wanneer een document is geregistreerd. (Omgevingsdocument)",
      "format": "date-time",
      "type": "string"
    },
    "beschikbaarVanaf": {
      "description": "Tijdstip dat aangeeft vanaf wanneer een document is geregistreerd. (Omgevingsdocument)",
      "format": "date-time",
      "type": "string"
    },
    "geldigTot": {
      "description": "Datum die aangeeft tot wanneer een document geldig is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "geldigVanaf": {
      "description": "Datum die aangeeft vanaf wanneer een document geldig is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "geometrieIdentificaties": {
      "description": "Identificaties van geometrieën behorende bij het document.",
      "items": {
        "examples": [
          "f3d5eee5-007b-42bd-be73-83ea1451c0f3"
        ],
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    },
    "heeftVectorTiles": {
      "description": "Er zijn vector tiles aanwezig voor dit document.",
      "examples": [
        true
      ],
      "type": "boolean"
    },
    "identificatie": {
      "description": "Identificatie van het document (AKN bij omgevingsdocument, planId bij IMRO-document).",
      "examples": [
        "/akn/nl/act/gm0301/2020/omgevingsplan"
      ],
      "type": "string"
    },
    "imroDocumentMetadata": {
      "$ref": "./imrodocumentmetadata"
    },
    "inwerkingTot": {
      "description": "Datum die aangeeft tot wanneer een document juridisch geldend is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "inwerkingVanaf": {
      "description": "Datum die aangeeft vanaf wanneer een document juridisch geldend is. (Omgevingsdocument)",
      "examples": [
        "2015-03-25"
      ],
      "format": "date",
      "type": "string"
    },
    "omgevingsdocumentMetadata": {
      "$ref": "./omgevingsdocumentmetadata"
    },
    "titel": {
      "description": "Titel van het document. Voor omgevingsdocumenten is dit de `citeertitel`, als die niet bekend is wordt de\n`officieleTitel` gebruikt. Voor IMRO-documenten is dit `naam`.",
      "examples": [
        "Bestemmingplan Lemmer Centrum"
      ],
      "type": "string"
    },
    "type": {
      "description": "Type van het document, bijvoorbeeld wijzigingsplan of omgevingsplan.",
      "enum": [
        "aanwijzingsbesluit",
        "Aanwijzingsbesluit N2000",
        "amvb",
        "AMvB",
        "beheersverordening",
        "bestemmingsplan",
        "exploitatieplan",
        "gemeentelijk besluit; overig",
        "gemeentelijk plan; bestemmingsplan artikel 10",
        "gemeentelijk plan; uitwerkingsplan artikel 11",
        "gemeentelijk plan; voorbereidingsbesluit",
        "gemeentelijk plan; wijzigingsplan artikel 11",
        "gemeentelijke visie; overig",
        "gerechtelijke uitspraak",
        "inpassingsplan",
        "Instructie",
        "Ministeriële Regeling",
        "Omgevingsplan",
        "Omgevingsplanregels Projectbesluit",
        "omgevingsvergunning",
        "Omgevingsvergunning",
        "Omgevingsverordening",
        "Omgevingsvisie",
        "Programma",
        "projectbesluit",
        "Projectbesluit",
        "provinciale verordening",
        "reactieve aanwijzing",
        "Reactieve interventie",
        "regeling",
        "structuurvisie",
        "tijdelijke ontheffing buitenplans",
        "Toegangsbeperkingsbesluit",
        "uitwerkingsplan",
        "voorbereidingsbesluit",
        "Voorbeschermingsregels",
        "Voorbeschermingsregels Omgevingsplan",
        "Voorbeschermingsregels Omgevingsverordening",
        "Waterschapsverordening",
        "wijzigingsplan"
      ],
      "examples": [
        "Omgevingsplan"
      ],
      "type": "string"
    },
    "uriIdentificatie": {
      "description": "URI-veilige identificatie, waarbij `/` is vervangen door `_`.",
      "examples": [
        "_akn_nl_act_gm0301_2020_omgevingsplan"
      ],
      "type": "string"
    },
    "versie": {
      "description": "Versienummer van het document.",
      "examples": [
        2
      ],
      "format": "int32",
      "type": "integer"
    }
  },
  "required": [
    "_links",
    "aangeleverdDoorEen",
    "beschikbaarVanaf",
    "geometrieIdentificaties",
    "heeftVectorTiles",
    "identificatie",
    "titel",
    "type",
    "uriIdentificatie",
    "versie"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/omgevingsinformatie/api/ontsluiten/v2/openapi.json#/components/schemas/Document"
  ]
}

Metadata

Aangemaakt op: 21-7-2026
Laatst gecrawld op: 6-8-2026
ID: fm8BM7EvR

Schema-register: document

Details van JSON Schema: document

Details van JSON Schema: document

Beschrijving