bijlage | Schema-register

Dialect2020-12

Typeunknown

Eigenschappen

Eigenschappen van het JSON Schema
Eigenschap	Type	Verplicht	Beschrijving en details
classificatie	`string`	Ja	Classificatie van de uitvoeringsregel waarmee deze zijn in te delen in de user interface. Enum: project, aanvrager, verzoek, activiteit
documenttypeGeneriek	`string`	Ja	Het generieke documenttype van de bijlage. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.
id	`integer`	Ja	De unieke identifier van de bijlage.
potentieelVertrouwelijk	`boolean`	Ja	Kenmerk potentieelVertrouwelijk=true betekent dat een gebruiker kan aangeven dat een antwoord op een vraag vertrouwelijk is. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.
publiceerbaar	`boolean`	Ja	Kenmerk publiceerbaar=true betekent dat het antwoord op de vraag gepubliceerd mag worden. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.
toelichting	`object`	Nee	Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service
toelichting.belangrijk	`boolean`	Ja	Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.
toelichting.korteToelichtingId	`integer`	Nee	identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig
toelichting.langeToelichtingId	`integer`	Nee	identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig
type	`string`	Ja	Het bestandstype dat verwacht wordt.
verplicht	`boolean`	Ja	Kenmerk verplicht=true betekent dat een gebruiker een bijlage moet toevoegen.
vraagReferentie	`string`	Nee	Identificatie van een gegeven om door te geven met de aanvraag. De structuur hiervan is <namespace>:<referentie>, waarbij de namespace "imam" gebruikt wordt voor de gegevens uit de IMAM (Informatie Model Aanvragen en Meldingen) standaard.

JSON Schema

{
  "$id": "https://schemas.don.projects.digilab.network/schemas/api-register/digitaal-stelsel-omgevingswet-dso/toepasbare-regels-uitvoeren-services-w8vc6lgvg/bijlage",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "classificatie": {
      "description": "Classificatie van de uitvoeringsregel waarmee deze zijn in te delen in de user interface.",
      "enum": [
        "project",
        "aanvrager",
        "verzoek",
        "activiteit"
      ],
      "type": "string"
    },
    "documenttypeGeneriek": {
      "description": "Het generieke documenttype van de bijlage. Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
      "type": "string"
    },
    "id": {
      "description": "De unieke identifier van de bijlage.",
      "type": "integer"
    },
    "potentieelVertrouwelijk": {
      "description": "Kenmerk potentieelVertrouwelijk=true betekent dat een gebruiker kan aangeven dat een antwoord op een vraag vertrouwelijk is.  Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
      "type": "boolean"
    },
    "publiceerbaar": {
      "description": "Kenmerk publiceerbaar=true betekent dat het antwoord op de vraag gepubliceerd mag worden.  Dit kan conform de IMAM (Informatie Model Aanvragen en Meldingen) standaard worden doorgeven aan het bevoegd gezag.",
      "type": "boolean"
    },
    "toelichting": {
      "description": "Verwijzing naar de toelichting bij de vraag. De inhoud van de toelichting kan opgehaald worden bij de toelichtingen service",
      "properties": {
        "belangrijk": {
          "description": "Definieert of de toelichting belangrijk is voor het ondersteunen en begrijpen van de vraag of het antwoord. Dit kan bijvoorbeeld gebruikt worden door frontend-applicaties als indicatie dat de toelichting direct getoond dient te worden.",
          "type": "boolean"
        },
        "korteToelichtingId": {
          "description": "identifier waarmee de korte toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
          "type": "integer"
        },
        "langeToelichtingId": {
          "description": "identifier waarmee de lange toelichting geidentificeerd wordt in de toelichtingen service. Indien er geen toelichting beschikbaar is is dit veld afwezig",
          "type": "integer"
        }
      },
      "required": [
        "belangrijk"
      ]
    },
    "type": {
      "description": "Het bestandstype dat verwacht wordt.",
      "type": "string"
    },
    "verplicht": {
      "description": "Kenmerk verplicht=true betekent dat een gebruiker een bijlage moet toevoegen.",
      "type": "boolean"
    },
    "vraagReferentie": {
      "description": "Identificatie van een gegeven om door te geven met de aanvraag. De structuur hiervan is <namespace>:<referentie>, waarbij de namespace \"imam\" gebruikt wordt voor de gegevens uit de IMAM (Informatie Model Aanvragen en Meldingen) standaard.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "type",
    "documenttypeGeneriek",
    "classificatie",
    "verplicht",
    "publiceerbaar",
    "potentieelVertrouwelijk"
  ],
  "x-derived-from": [
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v2.json#/components/schemas/Bijlage",
    "https://developer.omgevingswet.overheid.nl/publish/pages/171046/toepasbareregels-uitvoerenservices-v3.json#/components/schemas/Bijlage"
  ]
}

Schema gebruiken

JSON Schema

Bundled JSON Schema

Open in JSON Schema Viewer

Dependencies

Dit schema gebruikt geen andere schema's.

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 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
Setting `type` alongside `enum` is considered an anti-pattern, as the enumeration choices already imply their respective types	`/properties/classificatie/enum – /properties/classificatie/type`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/classificatie/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/documenttypeGeneriek/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/id/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/potentieelVertrouwelijk/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/publiceerbaar/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/toelichting/properties/belangrijk/description`
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/verplicht/description`
Descriptions should not end with a period to give user interfaces flexibility in presenting the text	`/properties/vraagReferentie/description`

Schema-register: bijlage

Details van JSON Schema: bijlage

Details van JSON Schema: bijlage

Beschrijving