concept | Schema-register

Dialect2020-12

Typeobject

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
begindatumGeldigheid	`string`	Ja	- Pattern: ^(\d{4}-[01]\d-[0-3]\d)$
bestaatUit	`array, null`	Ja	Relatie naar andere concepten (skosthes:narrowerPartitive) Items type: string
bronnen	`array, null`	Ja	Array met verwijzingen middels url's naar de bronnen Items type: string
codes	`array, null`	Ja	Codes met betrekking tot het concept. Items type: string
conceptschema	`string`	Ja	-
definitie	`string, null`	Ja	-
deprecated	`boolean, null`	Nee	-
eigenaar	`string, null`	Ja	-
einddatumGeldigheid	`string, null`	Ja	- Pattern: ^(\d{4}-[01]\d-[0-3]\d)$
heeftBetrekkingOp	`array, null`	Ja	Relatie naar andere concepten (skos:semanticRelation) Items type: string
isBrederDan	`array, null`	Ja	Relatie naar andere concepten (skos:broadMatch) Items type: string
isEngerDan	`array, null`	Ja	Relatie naar andere concepten (skos:narrowMatch) Items type: string
isGeneralisatieVan	`array, null`	Ja	Relatie naar andere concepten (skosthes:narrowerGeneric) Items type: string
isGerelateerd	`array, null`	Ja	Relatie naar andere concepten (skos:related) Items type: string
isHarmonisatie	`array, null`	Ja	Relatie naar andere concepten (skos:mappingRelation) Items type: string
isHetzelfdeAls	`array, null`	Ja	Relatie naar andere concepten (skos:exactMatch) Items type: string
isOnderdeelVan	`array, null`	Ja	Relatie naar andere concepten (skosthes:broaderPartitive) Items type: string
isOngeveerHetzelfdeAls	`array, null`	Ja	Relatie naar andere concepten (skos:closeMatch) Items type: string
isSpecialisatieVan	`array, null`	Ja	Relatie naar andere concepten (skosthes:broaderGeneric) Items type: string
metadata	`string, null`	Ja	-
naam	`string`	Ja	-
rationales	`array, null`	Ja	Waarom is er voor deze definitie gekozen? Items type: string
synoniemen	`array, null`	Ja	Array met woorden die synoniem zijn aan het concept Items type: string
term	`string`	Ja	-
toelichtingen	`array, null`	Ja	Array met aanvullende toelichtingen op de definitie indien gewenst. Items type: string
trefwoorden	`array, null`	Ja	Trefwoorden Items type: string
type	`string`	Ja	-
uitleg	`string, null`	Ja	Uitleg over de definitie in 'begrijpelijke' taal.
uri	`string`	Ja	-
verbeeldingen	`array, null`	Ja	Verwijzing middels een url naar een afbeelding. Items type: string
verborgenZoektermen	`array, null`	Ja	- Items type: string
zieOok	`array, null`	Ja	Relatie naar andere concepten (skos:relatedMatch) Items type: string

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/catalogus-api-wl_g_invg/concept",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "begindatumGeldigheid": {
      "examples": [
        "2020-04-17"
      ],
      "pattern": "^(\\d{4}-[01]\\d-[0-3]\\d)$",
      "type": "string"
    },
    "bestaatUit": {
      "description": "Relatie naar andere concepten (skosthes:narrowerPartitive)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "bronnen": {
      "description": "Array met verwijzingen middels url's naar de bronnen",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/id/bibliograficresouce/restfull-programming"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "codes": {
      "description": "Codes met betrekking tot het concept.",
      "examples": [
        [
          303.4833
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "conceptschema": {
      "examples": [
        "http://stelselcatalogus.omgevingswet.overheid.nl/id/conceptscheme/Stelselcatalogus"
      ],
      "type": "string"
    },
    "definitie": {
      "examples": [
        "Een API (Application Programming Interface) is een software-interface die het mogelijk maakt dat twee applicaties met elkaar kunnen communiceren."
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "deprecated": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "eigenaar": {
      "examples": [
        "https://standaarden.overheid.nl/owms/terms/Geonovum"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "einddatumGeldigheid": {
      "examples": [
        "2020-04-27"
      ],
      "pattern": "^(\\d{4}-[01]\\d-[0-3]\\d)$",
      "type": [
        "string",
        "null"
      ]
    },
    "heeftBetrekkingOp": {
      "description": "Relatie naar andere concepten (skos:semanticRelation)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isBrederDan": {
      "description": "Relatie naar andere concepten (skos:broadMatch)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isEngerDan": {
      "description": "Relatie naar andere concepten (skos:narrowMatch)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isGeneralisatieVan": {
      "description": "Relatie naar andere concepten (skosthes:narrowerGeneric)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isGerelateerd": {
      "description": "Relatie naar andere concepten (skos:related)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isHarmonisatie": {
      "description": "Relatie naar andere concepten (skos:mappingRelation)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isHetzelfdeAls": {
      "description": "Relatie naar andere concepten (skos:exactMatch)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isOnderdeelVan": {
      "description": "Relatie naar andere concepten (skosthes:broaderPartitive)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isOngeveerHetzelfdeAls": {
      "description": "Relatie naar andere concepten (skos:closeMatch)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "isSpecialisatieVan": {
      "description": "Relatie naar andere concepten (skosthes:broaderGeneric)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "metadata": {
      "examples": [
        "http://stelselcatalogus.omgevingswet.overheid.nl/programming/doc/2018041200000000/concept/API"
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "naam": {
      "examples": [
        "Application programming interface"
      ],
      "type": "string"
    },
    "rationales": {
      "description": "Waarom is er voor deze definitie gekozen?",
      "examples": [
        [
          "Definitie is in samenspraak met een grote groep mensen tot stand gekomen."
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "synoniemen": {
      "description": "Array met woorden die synoniem zijn aan het concept",
      "examples": [
        [
          "Application Programming Interface",
          "Digitaal informatie uitwisselingskanaal"
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "term": {
      "examples": [
        "Application programming interface"
      ],
      "type": "string"
    },
    "toelichtingen": {
      "description": "Array met aanvullende toelichtingen op de definitie indien gewenst.",
      "examples": [
        [
          "API's kunnen zowel in REST als in SOAP vorm voorkomen."
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "trefwoorden": {
      "description": "Trefwoorden",
      "examples": [
        [
          "uitbouwen",
          "aanbouwen",
          "garage"
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "type": {
      "examples": [
        "http://www.w3.org/2004/02/skos/core#Concept"
      ],
      "type": "string",
      "x-dws-expr": "`http://www.w3.org/2004/02/skos/core#Concept`"
    },
    "uitleg": {
      "description": "Uitleg over de definitie in 'begrijpelijke' taal.",
      "examples": [
        "Je zou kunnen zeggen dat een API de boodschapper is die een verzoek indient bij een provider en vervolgens het antwoord terugkoppelt naar jou."
      ],
      "type": [
        "string",
        "null"
      ]
    },
    "uri": {
      "examples": [
        "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/API"
      ],
      "type": "string"
    },
    "verbeeldingen": {
      "description": "Verwijzing middels een url naar een afbeelding.",
      "examples": [
        [
          "https://d1.awsstatic.com/serverless/New-API-GW-Diagram.c9fc9835d2a9aa00ef90d0ddc4c6402a2536de0d.png"
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "verborgenZoektermen": {
      "examples": [
        [
          "API",
          "REST",
          "SOAP"
        ]
      ],
      "items": {
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "zieOok": {
      "description": "Relatie naar andere concepten (skos:relatedMatch)",
      "items": {
        "examples": [
          "http://stelselcatalogus.omgevingswet.overheid.nl/programming/id/concept/SOAP"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    }
  },
  "required": [
    "begindatumGeldigheid",
    "bestaatUit",
    "bronnen",
    "codes",
    "conceptschema",
    "definitie",
    "eigenaar",
    "einddatumGeldigheid",
    "heeftBetrekkingOp",
    "isBrederDan",
    "isEngerDan",
    "isGeneralisatieVan",
    "isGerelateerd",
    "isHarmonisatie",
    "isHetzelfdeAls",
    "isLidVan",
    "isOnderdeelVan",
    "isOngeveerHetzelfdeAls",
    "isSpecialisatieVan",
    "metadata",
    "naam",
    "rationales",
    "synoniemen",
    "term",
    "toelichtingen",
    "trefwoorden",
    "type",
    "uitleg",
    "uri",
    "verbeeldingen",
    "verborgenZoektermen",
    "zieOok"
  ],
  "type": "object",
  "x-derived-from": [
    "https://service.omgevingswet.overheid.nl/publiek/catalogus/api/opvragen/v3/openapi.json#/components/schemas/Concept"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

Dit schema wordt gebruikt door
Schema	Locatie
embedded	`/properties/concepten/items/$ref`
embedded2	`/properties/concepten/items/$ref`
embedded3	`/properties/waarden/items/$ref`

Health issues

Health issues
Message	Pointer
Every property listed in the `required` keyword must be explicitly defined using the `properties` keyword	`/required/15`
Set a concise non-empty title at the top level of the schema to explain what the definition is about
Set a non-empty description at the top level of the schema to explain what the definition is about in detail
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	`/properties/codes/description`
Only include instances in the `examples` array that validate against the schema	`/properties/codes/examples/0`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/toelichtingen/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/uitleg/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/verbeeldingen/description`

Schema-register: concept

Details van JSON Schema: concept

Details van JSON Schema: concept

Beschrijving