PatchedZaakObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vng-realisatie/main/json-schema/vng-realisatie-patched-zaak-object-schema.json",
  "title": "PatchedZaakObject",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/vng-realisatie-zaken-openapi.yml#/components/schemas/PatchedZaakObject",
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "title": "url",
      "description": "URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.",
      "minLength": 1,
      "maxLength": 1000
    },
    "uuid": {
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "description": "Unieke resource identifier (UUID4)",
      "title": "uuid"
    },
    "zaak": {
      "type": "string",
      "format": "uri",
      "description": "URL-referentie naar de ZAAK.",
      "title": "zaak",
      "minLength": 1,
      "maxLength": 1000
    },
    "object": {
      "type": "string",
      "format": "uri",
      "description": "URL-referentie naar de resource die het OBJECT beschrijft.",
      "title": "object",
      "maxLength": 1000
    },
    "zaakobjecttype": {
      "type": "string",
      "format": "uri",
      "description": "URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API).",
      "title": "zaakobjecttype",
      "maxLength": 1000
    },
    "objectType": {
      "allOf": [
        {
          "$ref": "#/$defs/ObjectTypeEnum"
        }
      ],
      "description": "Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`.\n\nUitleg bij mogelijke waarden:\n\n* `adres` - Adres\n* `besluit` - Besluit\n* `buurt` - Buurt\n* `enkelvoudig_document` - Enkelvoudig document\n* `gemeente` - Gemeente\n* `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte\n* `huishouden` - Huishouden\n* `inrichtingselement` - Inrichtingselement\n* `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak\n* `kunstwerkdeel` - Kunstwerkdeel\n* `maatschappelijke_activiteit` - Maatschappelijke activiteit\n* `medewerker` - Medewerker\n* `natuurlijk_persoon` - Natuurlijk persoon\n* `niet_natuurlijk_persoon` - Niet-natuurlijk persoon\n* `openbare_ruimte` - Openbare ruimte\n* `organisatorische_eenheid` - Organisatorische eenheid\n* `pand` - Pand\n* `spoorbaandeel` - Spoorbaandeel\n* `status` - Status\n* `terreindeel` - Terreindeel\n* `terrein_gebouwd_object` - Terrein gebouwd object\n* `vestiging` - Vestiging\n* `waterdeel` - Waterdeel\n* `wegdeel` - Wegdeel\n* `wijk` - Wijk\n* `woonplaats` - Woonplaats\n* `woz_deelobject` - Woz deel object\n* `woz_object` - Woz object\n* `woz_waarde` - Woz waarde\n* `zakelijk_recht` - Zakelijk recht\n* `overige` - Overige",
      "title": "object type"
    },
    "objectTypeOverige": {
      "type": "string",
      "description": "Beschrijft het type OBJECT als `objectType` de waarde \"overige\" heeft.",
      "title": "object type overige",
      "pattern": "[a-z\\_]+",
      "maxLength": 100
    },
    "objectTypeOverigeDefinitie": {
      "allOf": [
        {
          "$ref": "#/$defs/ObjectTypeOverigeDefinitie"
        }
      ],
      "nullable": true,
      "title": "definitie object type overige",
      "description": "Verwijzing naar het schema van het type OBJECT als `objectType` de waarde \"overige\" heeft.\n\n* De URL referentie moet naar een JSON endpoint   wijzen waarin het objecttype gedefinieerd is, inclusief het   [JSON-schema](https://json-schema.org/).\n* Gebruik het `schema` attribuut om te verwijzen naar het schema binnen   de objecttype resource (deze gebruikt het   [jq](http://stedolan.github.io/jq/) formaat.\n* Gebruik het `objectData` attribuut om te verwijzen naar de gegevens   binnen het OBJECT. Deze gebruikt ook het   [jq](http://stedolan.github.io/jq/) formaat.\n\nIndien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype."
    },
    "relatieomschrijving": {
      "type": "string",
      "description": "Omschrijving van de betrekking tussen de ZAAK en het OBJECT.",
      "title": "relatieomschrijving",
      "maxLength": 80
    }
  },
  "$defs": {
    "ObjectTypeEnum": {
      "enum": [
        "adres",
        "besluit",
        "buurt",
        "enkelvoudig_document",
        "gemeente",
        "gemeentelijke_openbare_ruimte",
        "huishouden",
        "inrichtingselement",
        "kadastrale_onroerende_zaak",
        "kunstwerkdeel",
        "maatschappelijke_activiteit",
        "medewerker",
        "natuurlijk_persoon",
        "niet_natuurlijk_persoon",
        "openbare_ruimte",
        "organisatorische_eenheid",
        "pand",
        "spoorbaandeel",
        "status",
        "terreindeel",
        "terrein_gebouwd_object",
        "vestiging",
        "waterdeel",
        "wegdeel",
        "wijk",
        "woonplaats",
        "woz_deelobject",
        "woz_object",
        "woz_waarde",
        "zakelijk_recht",
        "overige"
      ],
      "type": "string"
    },
    "ObjectTypeOverigeDefinitie": {
      "type": "object",
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "title": "Objecttype-URL",
          "description": "URL-referentie naar de objecttype resource in een API. Deze resource moet de [JSON-schema](https://json-schema.org/)-definitie van het objecttype bevatten.",
          "maxLength": 1000
        },
        "schema": {
          "type": "string",
          "title": "schema-pad",
          "description": "Een geldige [jq](http://stedolan.github.io/jq/) expressie. Dit wordt gecombineerd met de resource uit het `url`-attribuut om het schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.",
          "maxLength": 100
        },
        "objectData": {
          "type": "string",
          "title": "objectgegevens-pad",
          "description": "Een geldige [jq](http://stedolan.github.io/jq/) expressie. Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens uit te lezen en de vorm van de gegevens tegen het schema te valideren. Bijvoorbeeld: `.record.data`.",
          "maxLength": 100
        }
      },
      "required": [
        "objectData",
        "schema",
        "url"
      ]
    }
  }
}