document | Schema-register

Document metadata van een omgevingsdocument of IMR0-document.

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_links	`$ref`	Ja	- $ref: ./hallinks
aangeleverdDoorEen	`$ref`	Ja	- $ref: ./bevoegdgezag
beschikbaarTot	`string`	Nee	Tijdstip dat aangeeft tot wanneer een document is geregistreerd. (Omgevingsdocument) Format: date-time
beschikbaarVanaf	`string`	Ja	Tijdstip dat aangeeft vanaf wanneer een document is geregistreerd. (Omgevingsdocument) Format: date-time
geldigTot	`string`	Nee	Datum die aangeeft tot wanneer een document geldig is. (Omgevingsdocument) Format: date
geldigVanaf	`string`	Nee	Datum die aangeeft vanaf wanneer een document geldig is. (Omgevingsdocument) Format: date
geometrieIdentificaties	`array`	Ja	Identificaties van geometrieën behorende bij het document. Unique items: true Items type: string
heeftVectorTiles	`boolean`	Ja	Er zijn vector tiles aanwezig voor dit document.
identificatie	`string`	Ja	Identificatie van het document (AKN bij omgevingsdocument, planId bij IMRO-document).
imroDocumentMetadata	`$ref`	Nee	- $ref: ./imrodocumentmetadata
inwerkingTot	`string`	Nee	Datum die aangeeft tot wanneer een document juridisch geldend is. (Omgevingsdocument) Format: date
inwerkingVanaf	`string`	Nee	Datum die aangeeft vanaf wanneer een document juridisch geldend is. (Omgevingsdocument) Format: date
omgevingsdocumentMetadata	`$ref`	Nee	- $ref: ./omgevingsdocumentmetadata
titel	`string`	Ja	Titel van het document. Voor omgevingsdocumenten is dit de `citeertitel`, als die niet bekend is wordt de `officieleTitel` gebruikt. Voor IMRO-documenten is dit `naam`.
type	`string`	Ja	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
uriIdentificatie	`string`	Ja	URI-veilige identificatie, waarbij `/` is vervangen door `_`.
versie	`integer`	Ja	Versienummer van het document. Format: int32

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"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
hallinks	`/properties/_links/$ref`
bevoegdgezag	`/properties/aangeleverdDoorEen/$ref`
imrodocumentmetadata	`/properties/imroDocumentMetadata/$ref`
omgevingsdocumentmetadata	`/properties/omgevingsdocumentMetadata/$ref`

Dit schema wordt gebruikt door
Schema	Locatie
embedded	`/properties/documenten/items/$ref`

Health issues

Health issues
Message	Pointer
Set a concise non-empty title at the top level of the schema to explain what the definition is about
Set a non-empty examples array at the top level of the schema to illustrate the expected data
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/geometrieIdentificaties/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/heeftVectorTiles/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/identificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/titel/description`
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/type/enum – /properties/type/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/type/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/uriIdentificatie/description`
Avoid keywords that don't apply to the type or types that the current subschema expects	`/properties/versie/format`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/versie/description`
For interoperability purposes, the JSON Schema specification advises against the use of `format` values that are not explicitly defined by the specification	`/properties/versie/format`

Schema-register: document

Details van JSON Schema: document

Details van JSON Schema: document

Beschrijving