werkzaamheidversiehalresponselistwithexpand

Lijst van werkzaamheid versies met HAL links en eventueel gerelateerde gegevens (in het geval _expand is gebruikt)

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
_embedded	`object`	Nee	-
_embedded.werkzaamheidversies	`array`	Ja	- Min items: 1 Items type: allOf
_embedded.werkzaamheidversies[].allOf[1].beginDatum	`string`	Ja	Datum in het formaat yyyy-MM-dd Format: date Pattern: ^\d{4}-\d{2}-\d{2}$
_embedded.werkzaamheidversies[].allOf[1].eindDatum	`string`	Nee	Datum in het formaat yyyy-MM-dd Format: date Pattern: ^\d{4}-\d{2}-\d{2}$
_embedded.werkzaamheidversies[].allOf[1].omschrijving	`string`	Ja	Omschrijving van de werkzaamheid versie Min length: 1 Max length: 250
_embedded.werkzaamheidversies[].allOf[1].urn	`string`	Ja	Urn van de werkzaamheid Pattern: ^\w{1,100}$
_embedded.werkzaamheidversies[].allOf[2]._embedded	`object`	Nee	-
_embedded.werkzaamheidversies[].allOf[2]._embedded.logischeRelaties	`array`	Nee	De werkzaamheden waarnaar een logische relatie bestaat. Items type: allOf
_embedded.werkzaamheidversies[].allOf[2]._embedded.logischeRelaties[].allOf[1].urn	`string`	Ja	Urn van de werkzaamheid Pattern: ^\w{1,100}$
_embedded.werkzaamheidversies[].allOf[2]._embedded.logischeRelaties[].allOf[2]._links	`object`	Ja	-
_embedded.werkzaamheidversies[].allOf[2]._embedded.logischeRelaties[].allOf[2]._links.versies	`object`	Ja	HAL link
_embedded.werkzaamheidversies[].allOf[2]._embedded.logischeRelaties[].allOf[2]._links.versies.href	`string`	Ja	URI
_embedded.werkzaamheidversies[].allOf[2]._embedded.trefwoorden	`array`	Nee	Trefwoorden van de werkzaamheid versie Min items: 0 Max items: 500 Items type: string
_links	`object`	Ja	Links om te navigeren door de paginering
_links.first	`object`	Ja	HAL link
_links.first.href	`string`	Ja	URI
_links.last	`object`	Ja	HAL link
_links.last.href	`string`	Ja	URI
_links.next	`object`	Nee	HAL link
_links.next.href	`string`	Ja	URI
_links.prev	`object`	Nee	HAL link
_links.prev.href	`string`	Ja	URI
_links.self	`object`	Ja	HAL link
_links.self.href	`string`	Ja	URI
page	`$ref`	Ja	- $ref: ./page

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/opvragen-werkzaamheden-zblce_rdr/werkzaamheidversiehalresponselistwithexpand",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Lijst van werkzaamheid versies met HAL links en eventueel gerelateerde gegevens (in het geval _expand is gebruikt)",
  "properties": {
    "_embedded": {
      "properties": {
        "werkzaamheidversies": {
          "items": {
            "allOf": [
              {
                "description": "Werkzaamheid versie gegevens",
                "properties": {
                  "beginDatum": {
                    "description": "Datum in het formaat yyyy-MM-dd",
                    "examples": [
                      "2023-01-01"
                    ],
                    "format": "date",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "type": "string"
                  },
                  "eindDatum": {
                    "description": "Datum in het formaat yyyy-MM-dd",
                    "examples": [
                      "2023-01-01"
                    ],
                    "format": "date",
                    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
                    "type": "string"
                  },
                  "omschrijving": {
                    "description": "Omschrijving van de werkzaamheid versie",
                    "examples": [
                      "Vellen van een houtopstand"
                    ],
                    "maxLength": 250,
                    "minLength": 1,
                    "type": "string"
                  },
                  "urn": {
                    "description": "Urn van de werkzaamheid",
                    "examples": [
                      "BoomKappen"
                    ],
                    "pattern": "^\\w{1,100}$",
                    "type": "string"
                  }
                },
                "required": [
                  "urn",
                  "omschrijving",
                  "beginDatum"
                ]
              },
              {
                "properties": {
                  "_embedded": {
                    "properties": {
                      "logischeRelaties": {
                        "description": "De werkzaamheden waarnaar een logische relatie bestaat.",
                        "items": {
                          "allOf": [
                            {
                              "description": "Werkzaamheid gegevens",
                              "properties": {
                                "urn": {
                                  "description": "Urn van de werkzaamheid",
                                  "examples": [
                                    "BoomKappen"
                                  ],
                                  "pattern": "^\\w{1,100}$",
                                  "type": "string"
                                }
                              },
                              "required": [
                                "urn"
                              ]
                            },
                            {
                              "properties": {
                                "_links": {
                                  "properties": {
                                    "versies": {
                                      "description": "HAL link",
                                      "properties": {
                                        "href": {
                                          "description": "URI",
                                          "type": "string"
                                        }
                                      },
                                      "required": [
                                        "href"
                                      ]
                                    }
                                  },
                                  "required": [
                                    "versies"
                                  ]
                                }
                              },
                              "required": [
                                "_links"
                              ]
                            }
                          ],
                          "description": "Werkzaamheid met HAL links"
                        },
                        "type": "array"
                      },
                      "trefwoorden": {
                        "description": "Trefwoorden van de werkzaamheid versie",
                        "examples": [
                          [
                            "Omhakken",
                            "Boom"
                          ]
                        ],
                        "items": {
                          "description": "Trefwoord van de werkzaamheid versie",
                          "examples": [
                            "Omhakken"
                          ],
                          "maxLength": 250,
                          "minLength": 1,
                          "type": "string"
                        },
                        "maxItems": 500,
                        "minItems": 0,
                        "type": "array"
                      }
                    }
                  }
                }
              }
            ],
            "description": "Werkzaamheid versie met HAL links"
          },
          "minItems": 1,
          "type": "array"
        }
      },
      "required": [
        "werkzaamheidversies"
      ]
    },
    "_links": {
      "description": "Links om te navigeren door de paginering",
      "properties": {
        "first": {
          "description": "HAL link",
          "properties": {
            "href": {
              "description": "URI",
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "last": {
          "description": "HAL link",
          "properties": {
            "href": {
              "description": "URI",
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "next": {
          "description": "HAL link",
          "properties": {
            "href": {
              "description": "URI",
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "prev": {
          "description": "HAL link",
          "properties": {
            "href": {
              "description": "URI",
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "self": {
          "description": "HAL link",
          "properties": {
            "href": {
              "description": "URI",
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        }
      },
      "required": [
        "self",
        "first",
        "last"
      ]
    },
    "page": {
      "$ref": "./page"
    }
  },
  "required": [
    "_links",
    "page"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/239140/toepasbareregels-opvragenwerkzaamheden-v1.json#/components/schemas/WerkzaamheidVersieHALResponseListWithExpand"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Gebruikt door dit schema
Schema	Locatie
page	`/properties/page/$ref`

Dit schema wordt niet door andere schema's gebruikt.

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
Keywords inside `allOf` that do not conflict with the parent schema can be elevated	`/properties/_embedded/properties/werkzaamheidversies/items/allOf/0/required`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/_embedded/properties/werkzaamheidversies/items/allOf/1/properties/_embedded/properties/logischeRelaties/description`

Schema-register: werkzaamheidversiehalresponselistwithexpand

Details van JSON Schema: werkzaamheidversiehalresponselistwithexpand

Details van JSON Schema: werkzaamheidversiehalresponselistwithexpand

Beschrijving