# info.description
## Documentatie

De GPP-publicatiebank API stelt client-applicaties in staat om publicaties van documenten te raadplegen en te beheren in het kader van een open overheid. Deze API-documentatie bevat drie logische 'domeinen'.

### Domeinen

**Metadata**

Publicaties en hun gerelateerde documenten moeten bepaalde metadata hebben. De metadata-endpoints stellen client-applicaties in staat om beschikbare metadata op te halen (en in sommige resources ook aan te maken of bij te werken).

* [Organisaties](#tag/Organisaties): bekende overheidsorganisaties, zoals gemeentes, provincies...
* [Informatiecategorieën](#tag/Informatiecategorieen): de voorgeschreven categorieën voor de [DiWoo](https://standaarden.overheid.nl/diwoo/metadata)-standaard, optioneel uitgebreid met organisatiespecifieke categorieën.
* [Thema's](#tag/Themas): een boomstructuur van ouder/kind-thema's om verder te beschrijven waar publicaties over gaan.

**Publicaties**

* [Publicaties](#tag/Publicaties): een publicatie is een logische eenheid van informatie die openbaar gemaakt moet worden - die kan één of meerdere documenten bevatten. Metadata wordt typisch gekoppeld aan de publicatie in plaats van aan de documenten die erin zitten.
* [Documenten](#tag/Documenten): de daadwerkelijke bestanden/documenten die openbaar worden gemaakt en geïndexeerd in zoekmachines.

**Catalogi API**

De [Catalogi API](#tag/Catalogi-API)-eindpunten zijn een implementatiedetail van hoe deze API werkt. Client-applicaties hoeven hier niets mee te doen.
Ze zijn nodig om de Documenten API te kunnen hergebruiken voor de daadwerkelijke opslag van bestanden.

### Authenticatie

**API-sleutel**

De API-endpoints vereisen authenticatie waarvoor je een API-sleutel moet hebben. API-sleutels worden aangemaakt in de beheerinterface (zie de functionele documentatie).

Wanneer je een API-sleutel hebt, dan moet je deze meesturen in elk verzoek in een request header:

```
Authorization: Token mijn-voorbeeld-api-sleutel
```

Vervang `mijn-voorbeeld-api-sleutel` door je eigen API-sleutel.

**Audit-headers**

Daarnaast vereisen de meeste endpoints dat er request headers worden meegestuurd voor de audit logs:

```
Audit-User-ID: unieke-identificatie@example.com
Audit-User-Representation: Alice B. Tables
Audit-Remarks: Eigen publicaties ophalen
```

# paths./api/v2/accounts/organisatie-eenheden.get.description
Geeft een lijst (met paginering) terug van alle bestaande organisatie-eenheden.

# paths./api/v2/accounts/organisatie-eenheden.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/accounts/organisatie-eenheden.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/accounts/organisatie-eenheden.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/accounts/organisatie-eenheden.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.get.description
Haal een specifieke organisatie-eenheid op.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.get.summary
Haal een specifieke organisatie-eenheid op.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.put.description
Werk de metadata van een specifieke organisatie-eenheid bij.

The volgende attributen mogen niet aangepast worden na de initiële creatie:
* `identifier`

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.put.summary
Werk de metadata van een specifieke organisatie-eenheid bij.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.put.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.put.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.put.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.patch.description
Werk de metadata van een specifieke organisatie-eenheid gedeeltelijk bij.

The volgende attributen mogen niet aangepast worden na de initiële creatie:
* `identifier`

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.patch.summary
Werk de metadata van een specifieke organisatie-eenheid gedeeltelijk bij.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.patch.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.patch.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/accounts/organisatie-eenheden/{identifier}.patch.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten.get.description
Geeft een resultatenlijst (met paginering) terug van de bestaande documenten.

# paths./api/v2/documenten.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op creatiedatum voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op creatiedatum op of voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op creatiedatum op of na de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op basis van de identificatie van de eigenaar.

# paths./api/v2/documenten.get.parameters[].description
Search the document based on the identifier field.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten die binnen een bepaalde informatiecategorie vallen. Als je meerdere categorieën opgeeft, dan krijg je alle documenten die aan één van deze categorieën gerelateerd zijn.

De filterwaarden zijn UUIDs van de categorieën. Gebruik komma's om meerdere waarden van elkaar te scheiden.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op laastste wijzigingsdatum voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op laastste wijzigingsdatum op of voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op laastste wijzigingsdatum op of na de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op basis van de unieke publicatie-identificatie (UUID) waartoe ze horen.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op publicatiestatus.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op registratiedatum voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op registratiedatum op of voor de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Filter documenten op registratiedatum op of na de opgegeven datumtijd.

# paths./api/v2/documenten.get.parameters[].description
Sorteren op.

* `creatiedatum` - Creatiedatum
* `-creatiedatum` - Creatiedatum (aflopend)
* `officiele_titel` - Officiele titel
* `-officiele_titel` - Officiele titel (aflopend)
* `verkorte_titel` - Verkorte titel
* `-verkorte_titel` - Verkorte titel (aflopend)

# paths./api/v2/documenten.post.description
Het registreren van een document zorgt ervoor dat de metadata vastgelegd wordt en geeft informatie terug aan de client zodat de bestandsinhoud geüpload kan worden.

Het document (= de metadata) wordt meteen vastgelegd in de achterliggende Documenten-API, en je krijgt een lijst van bestandsdelen terug in het antwoord waarmee je de eigenlijke bestandsinhoud kan uploaden.

Merk op dat de record in de achterliggende Documenten-API vergrendeld is tot dat alle bestandsdelen toegevoegd zijn.

**NOTE**
Je moet hiervoor een aantal algemene instellingen doen in de beheeromgeving. Met name:

* een Documenten-API-service instellen en selecteren
* een organisatie-RSIN instellen om te gebruiken voor geregistreerde documenten

# paths./api/v2/documenten.post.summary
Registreer de metadata van een document.

# paths./api/v2/documenten.post.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten.post.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten.post.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}.put.description
Werk de metadata van een specifiek document bij.

# paths./api/v2/documenten/{uuid}.put.summary
Werk de metadata van een specifiek document bij.

# paths./api/v2/documenten/{uuid}.put.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}.put.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}.put.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}.patch.description
Werk de metadata van een specifiek document gedeeltelijk bij.

# paths./api/v2/documenten/{uuid}.patch.summary
Werk de metadata van een specifiek document gedeeltelijk bij.

# paths./api/v2/documenten/{uuid}.patch.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}.patch.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}.patch.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}.delete.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}.delete.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}.delete.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}/bestandsdelen/{partUuid}.put.description
Upload de binaire data voor een bestandsdeel. De response van de document create endpoint geeft een lijst van verwachtte bestandsdelen terug die naar dit endpoint verwijzen. De client moet het bestand opknippen in de verwachtte bestandsdeelgroottes en dan elk stuk individueel uploaden.

Eenmaal alle bestandsdelen voor het document ontvangen zijn, zal het document automatisch ontgrendeld worden in de achterliggende Documenten-API en dan is het document klaar voor gebruik.

**NOTE** dit endpoint verwacht `multipart/form-data` gegevens in plaats van JSON - op deze manier kan de base64-encoding overhead voorkomen worden.

# paths./api/v2/documenten/{uuid}/bestandsdelen/{partUuid}.put.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}/bestandsdelen/{partUuid}.put.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}/bestandsdelen/{partUuid}.put.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}/download.get.description
Download de inhoud van het document als binaire data. Dit endpoint geeft geen JSON terug, in de plaats daarvan wordt de bestandsinhoud direct gestreamed.

Je kan enkel bestanden downloaden waarvan de upload naar de achterliggende Documenten-API voltooid is.

# paths./api/v2/documenten/{uuid}/download.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/documenten/{uuid}/download.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/documenten/{uuid}/download.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/documenten/{uuid}/download.get.responses.200.headers.Content-Length.description
Totale grootte (in bytes) van de download.

# paths./api/v2/documenten/{uuid}/download.get.responses.200.headers.Content-Disposition.description
Markeert het bestand als 'bijlage' en bevat de bestandsnaam van het document.

# paths./api/v2/documenten/{uuid}/download.get.responses.409.description
Conflict - het document is (nog) niet beschikbaar voor download.

# paths./api/v2/documenten/{uuid}/download.get.responses.502.description
Bad gateway - kon de inhoud niet streamen.

# paths./api/v2/informatiecategorieen.get.description
Geeft een resultatenlijst (met paginering) terug van de bestaande informatiecategorieën.

# paths./api/v2/informatiecategorieen.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/informatiecategorieen.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/informatiecategorieen.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/informatiecategorieen.get.parameters[].description
Zoek een informatiecategorie op basis van de unieke IRI die een specifieke categorie identificeert.

# paths./api/v2/informatiecategorieen.get.parameters[].description
Zoek informatiecategorieën op basis van de categorienaam.

# paths./api/v2/informatiecategorieen.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/informatiecategorieen/{uuid}.get.description
Haal een specifiieke informatiecategorie op.

# paths./api/v2/informatiecategorieen/{uuid}.get.summary
Haal een specifiieke informatiecategorie op.

# paths./api/v2/informatiecategorieen/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/informatiecategorieen/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/informatiecategorieen/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/onderwerpen.get.description
Geeft een resultatenlijst (met paginering) terug van de bestaande onderwerpen.

# paths./api/v2/onderwerpen.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/onderwerpen.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/onderwerpen.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/onderwerpen.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/onderwerpen.get.parameters[].description
Filter onderwerpen die bij een bepaald onderwerp horen. Als je meerdere publicaties opgeeft, dan krijg je alle onderwerpen die aan één van deze publicaties gerelateerd zijn.

De filterwaarden zijn de UUIDs van de publicaties. Gebruik komma's om meerdere waarden van elkaar te scheiden.

# paths./api/v2/onderwerpen.get.parameters[].description
Filter onderwerpen op publicatiestatus.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# paths./api/v2/onderwerpen/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/onderwerpen/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/onderwerpen/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/organisaties.get.description
Geeft een lijst (met paginering) terug van alle bestaande organisaties.

# paths./api/v2/organisaties.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/organisaties.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/organisaties.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/organisaties.get.parameters[].description
Zoek een organisatie op basis van de unieke IRI die een specifieke organisatie identificeert.

# paths./api/v2/organisaties.get.parameters[].description
Filter de organisaties op hun actief-status:

* `true` - Haal alle actieve organisaties op (standaard).
* `false` - Haal alle inactieve organisaties op.
* `alle` - Haal alle organisaties op, ongeacht of ze actief zijn of niet.

# paths./api/v2/organisaties.get.parameters[].description
Zoek organisaties op basis van de organisatienaam. Je kan op delen van de naam zoeken, en het zoeken is niet hoofdlettergevoelig.

# paths./api/v2/organisaties.get.parameters[].description
Zoek organisaties op basis van de oorsprong van de gegevens.

* `gemeentelijst` - Register gemeenten compleet
* `solijst` - Register samenwerkingsorganisaties compleet
* `oorglijst` - Register overige overheidsorganisaties compleet
* `caribischelijst` - Caribische organisaties
* `provincielijst` - Provincielijst
* `waterschaplijst` - Waterschaplijst
* `zbolijst` - ZBO-lijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# paths./api/v2/organisaties.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/organisaties.post.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/organisaties.post.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/organisaties.post.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/organisaties/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/organisaties/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/organisaties/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/organisaties/{uuid}.put.description
Werk een organisatie (in zijn geheel) bij.

# paths./api/v2/organisaties/{uuid}.put.summary
Werk een organisatie (in zijn geheel) bij.

# paths./api/v2/organisaties/{uuid}.put.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/organisaties/{uuid}.put.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/organisaties/{uuid}.put.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/organisaties/{uuid}.patch.description
Werk een organisatie (gedeeltelijk) bij.

# paths./api/v2/organisaties/{uuid}.patch.summary
Werk een organisatie (gedeeltelijk) bij.

# paths./api/v2/organisaties/{uuid}.patch.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/organisaties/{uuid}.patch.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/organisaties/{uuid}.patch.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties.get.description
Geeft een gepagineerde lijst van bestaande publicaties terug.

**Opmerking**: wanneer je tegelijk op `eigenaar` en `eigenaarGroep` filtert, dan worden de publicaties waar één van beide condities geldt teruggegeven. De parameters hebben OF-gedrag wanneer ze gecombineerd worden.

# paths./api/v2/publicaties.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op archiefactiedatum voor de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op archiefactiedatum op of voor de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op archiefactiedatum op of na de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op archiefnominatie.

* `blijvend_bewaren` - Blijvend bewaren
* `vernietigen` - Vernietigen

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op basis van de opgegeven kenmerkbron.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op basis van de identificatie van de eigenaar.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op basis van de identificatie van de eigenaar (groep).

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties die binnen een bepaalde informatiecategorie vallen. Als je meerdere categorieën opgeeft, dan krijg je alle publicaties die aan één van deze categorieën gerelateerd zijn.

De filterwaarden zijn UUIDs van de categorieën. Gebruik komma's om meerdere waarden van elkaar te scheiden.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op basis van het opgegeven kenmerk.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties die bij een bepaald onderwerp horen. Als je meerdere onderwerpen opgeeft, dan krijg je alle publicaties die aan één van deze onderwerpen gerelateerd zijn.

De filterwaarden zijn de UUIDs van de onderwerpen. Gebruik komma's om meerdere waarden van elkaar te scheiden.

# paths./api/v2/publicaties.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op publicatiestatus.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op registratiedatum voor de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op registratiedatum op of voor de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Filter publicaties op registratiedatum op of na de opgegeven datumtijd.

# paths./api/v2/publicaties.get.parameters[].description
Doorzoek publicaties op officiële en verkorte titel (niet hoofdlettergevoelig en zoekt op delen van de zoekterm).

# paths./api/v2/publicaties.get.parameters[].description
Sorteren op.

* `registratiedatum` - Registratiedatum
* `-registratiedatum` - Registratiedatum (aflopend)
* `officiele_titel` - Officiele titel
* `-officiele_titel` - Officiele titel (aflopend)
* `verkorte_titel` - Verkorte titel
* `-verkorte_titel` - Verkorte titel (aflopend)

# paths./api/v2/publicaties.post.description
Maak een publicatie aan.

Bij het aanmaken van een conceptpublicatie is het enige verplichte veld  `officieleTitel`.

# paths./api/v2/publicaties.post.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties.post.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties.post.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties/{uuid}.put.description
Update een publicatie voledig.

Bij het updaten van een conceptpublicatie is het enige verplichte veld  `officieleTitel`.

# paths./api/v2/publicaties/{uuid}.put.summary
Werk een publicatie (in zijn geheel) bij.

# paths./api/v2/publicaties/{uuid}.put.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties/{uuid}.put.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties/{uuid}.put.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties/{uuid}.patch.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties/{uuid}.patch.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties/{uuid}.patch.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/publicaties/{uuid}.delete.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/publicaties/{uuid}.delete.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/publicaties/{uuid}.delete.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/themas.get.description
Geeft een resultatenlijst (met paginering) terug van de bestaande thema's.

# paths./api/v2/themas.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/themas.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/themas.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./api/v2/themas.get.parameters[].description
A page number within the paginated result set.

# paths./api/v2/themas/{uuid}.get.parameters[].description
Any additional information describing the action performed by the user.

# paths./api/v2/themas/{uuid}.get.parameters[].description
The system identifier that uniquely identifies the user performing the action.
Ideally, this is obtained from some Identity and Access Management
infrastructure. With OpenID Connect, this would typically be the `sub` claim.

# paths./api/v2/themas/{uuid}.get.parameters[].description
The display name of the user performing the action, to make them recognizable.

# paths./catalogi/api/v1/informatieobjecttypen/{uuid}.get.description
Expose an information category as a Catalogi API `informatieobjecttype`.

**NOTE**: this API endpoint is internal and used in the integration with the
Documenten API. Publication components are not expected to interact with it.

# components.schemas.AanleveringBestandEnum.description
* `ontvangen` - Ontvangen
* `ophalen` - Ophalen

# components.schemas.ArchiefnominatieEnum.description
* `blijvend_bewaren` - Blijvend bewaren
* `vernietigen` - Vernietigen

# components.schemas.CatalogiAPIDocumentType.properties.catalogus.description
URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.

# components.schemas.CatalogiAPIDocumentType.properties.informatieobjectcategorie.description
Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE.

# components.schemas.CatalogiAPIDocumentType.properties.omschrijving.description
Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE.

# components.schemas.CatalogiAPIDocumentType.properties.vertrouwelijkheidaanduiding.description
Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn.

* `openbaar` - Openbaar
* `beperkt_openbaar` - Beperkt openbaar
* `intern` - Intern
* `zaakvertrouwelijk` - Zaakvertrouwelijk
* `vertrouwelijk` - Vertrouwelijk
* `confidentieel` - Confidentieel
* `geheim` - Geheim
* `zeer_geheim` - Zeer geheim

# components.schemas.CatalogiAPIDocumentType.properties.concept.description
Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API.

# components.schemas.ConceptPublicationWrite.description
Base serializer for publication read and write operations.

This base class defines the shared logic that should be kept in sync between read
and write operations for consistent API documentation (and behaviour).

# components.schemas.ConceptPublicationWrite.properties.urlPublicatieIntern.title
Werk een publicatie (in zijn geheel) bij.

# components.schemas.ConceptPublicationWrite.properties.urlPublicatieIntern.description
De URL die verwijst naar de UI van de interne applicatie waar de publicatie beheerd wordt. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.ConceptPublicationWrite.properties.urlPublicatieExtern.description
De URL die verwijst naar de UI van de externe applicatie waar de publicatie publiek toegankelijk is. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.ConceptPublicationWrite.properties.informatieCategorieen.description
De informatiecategorie verduidelijkt de soort informatie die in de publicatie voorkomt.

# components.schemas.ConceptPublicationWrite.properties.diWooInformatieCategorieen.description
De informatiecategorieën voor in de sitemap.

# components.schemas.ConceptPublicationWrite.properties.onderwerpen.description
Onderwerpen gaan over maatschappelijk relevante informatie die meerdere publicaties omvatten. Ze kunnen tientallen jaren relevant blijven en overstijgen de typische levensduur van een enkele publicatie.

# components.schemas.ConceptPublicationWrite.properties.publisher.description
De organisatie die de publicatie publiceert.

# components.schemas.ConceptPublicationWrite.properties.verantwoordelijke.description
De organisatie die verantwoordelijk is voor de publicatie en haar inhoud.

# components.schemas.ConceptPublicationWrite.properties.opsteller.description
De organisatie die de publicatie en haar inhoud opgesteld heeft.

# components.schemas.ConceptPublicationWrite.properties.kenmerken.description
De set aan identificatiekenmerken horend bij deze publicatie.

# components.schemas.ConceptPublicationWrite.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.ConceptPublicationWrite.properties.eigenaarGroep.description
Niet-verplichte organisatie-eenheid die ook eigenaar is van de publicatie, naast de `eigenaar` (op persoonlijke titel).

# components.schemas.ConceptPublicationWrite.properties.publicatiestatus.description
**Waarschuwing**: je kan geen ingetrokken publicatie aanmaken.

**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.ConceptPublicationWrite.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.ConceptPublicationWrite.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.ConceptPublicationWrite.properties.registratiedatum.description
Systeemdatum en -tijd wanneer de publicatie in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.ConceptPublicationWrite.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer de publicatie laatst gewijzigd is in de database.

# components.schemas.ConceptPublicationWrite.properties.datumBeginGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten in werking treden.

# components.schemas.ConceptPublicationWrite.properties.datumEindeGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten (zijn) komen te vervallen.

# components.schemas.ConceptPublicationWrite.properties.bronBewaartermijn.description
De bron waaruit de bewaartermijn bepaald is (bjivoorbeeld: Selectielijst gemeenten 2020).
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.ConceptPublicationWrite.properties.selectiecategorie.description
De categorie waaruit de bewaartermijn bepaald is, zoals deze in de bron bewaartermijn voorkomt (bijvoorbeeld: 20.1.2).
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.ConceptPublicationWrite.properties.archiefnominatie.description
Geeft aan of de gegevens bij het archiveren bewaard blijven of definitief vernietigd worden.
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

* `blijvend_bewaren` - Blijvend bewaren
* `vernietigen` - Vernietigen

# components.schemas.ConceptPublicationWrite.properties.archiefactiedatum.description
Datum waarop de publicatie overgebracht of definitief vernietigd zal worden.
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.ConceptPublicationWrite.properties.toelichtingBewaartermijn.description
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.Document.properties.publicatie.description
De unieke identificatie van de publicatie.

# components.schemas.Document.properties.kenmerken.description
De set aan identificatiekenmerken horend bij dit document.

# components.schemas.Document.properties.publicatiestatus.description
Tijdens het aanmaken wordt de publicatiestatus overgenomen van het publicatie. De publicatie kan niet zelf ingevuld worden.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.Document.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.Document.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.Document.properties.creatiedatum.description
De datum waarop het document ontstaan is. Niet te verwarren met de registratiedatum - de creatiedatum valt typisch *voor* de registratiedatum.

# components.schemas.Document.properties.ontvangstdatum.description
Indien van toepassing, datum wanneer het document door of namens de organisatie in ontvangst is genomen.

# components.schemas.Document.properties.datumOndertekend.description
Indien van toepassing, datum waarop het document (door alle partijen) ondertekend is.

# components.schemas.Document.properties.bestandsformaat.description
TODO - placeholder accepting anything, in the future this will be validated against a reference value list.

# components.schemas.Document.properties.bestandsnaam.description
Bestandsnaam 'op de harde schijf' van het document, bijvoorbeeld 'gelakt-verslag.pdf'.

# components.schemas.Document.properties.bestandsomvang.description
Bestandsgrootte op de harde schijf, in bytes.

# components.schemas.Document.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.Document.properties.registratiedatum.description
Systeemdatum en -tijd wanneer het document in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.Document.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer het document laatst gewijzigd is in de database.

# components.schemas.Document.properties.uploadVoltooid.description
Geeft aan of alle bestandsdelen van het bestand ontvangen zijn en het document ontgrendeld en klaar voor gebruik is in de achterliggende Documenten-API.

# components.schemas.DocumentCreateShared.properties.publicatie.description
De unieke identificatie van de publicatie.

# components.schemas.DocumentCreateShared.properties.kenmerken.description
De set aan identificatiekenmerken horend bij dit document.

# components.schemas.DocumentCreateShared.properties.publicatiestatus.description
Tijdens het aanmaken wordt de publicatiestatus overgenomen van het publicatie. De publicatie kan niet zelf ingevuld worden.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.DocumentCreateShared.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.DocumentCreateShared.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.DocumentCreateShared.properties.creatiedatum.description
De datum waarop het document ontstaan is. Niet te verwarren met de registratiedatum - de creatiedatum valt typisch *voor* de registratiedatum.

# components.schemas.DocumentCreateShared.properties.ontvangstdatum.description
Indien van toepassing, datum wanneer het document door of namens de organisatie in ontvangst is genomen.

# components.schemas.DocumentCreateShared.properties.datumOndertekend.description
Indien van toepassing, datum waarop het document (door alle partijen) ondertekend is.

# components.schemas.DocumentCreateShared.properties.bestandsformaat.description
TODO - placeholder accepting anything, in the future this will be validated against a reference value list.

# components.schemas.DocumentCreateShared.properties.bestandsnaam.description
Bestandsnaam 'op de harde schijf' van het document, bijvoorbeeld 'gelakt-verslag.pdf'.

# components.schemas.DocumentCreateShared.properties.bestandsomvang.description
Bestandsgrootte op de harde schijf, in bytes.

# components.schemas.DocumentCreateShared.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.DocumentCreateShared.properties.registratiedatum.description
Systeemdatum en -tijd wanneer het document in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.DocumentCreateShared.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer het document laatst gewijzigd is in de database.

# components.schemas.DocumentCreateShared.properties.uploadVoltooid.description
Geeft aan of alle bestandsdelen van het bestand ontvangen zijn en het document ontgrendeld en klaar voor gebruik is in de achterliggende Documenten-API.

# components.schemas.DocumentCreateShared.properties.aanleveringBestand.description
Als de aanleverwijze op `ophalen` staat, dan wordt dit verwerkt op de achtergrond en worden er geen `bestandsdelen` teruggegeven in het antwoord. Voor directe uploads wordt er een lijst van verwachte `bestandsdelen` teruggegeven.

* `ontvangen` - Ontvangen
* `ophalen` - Ophalen

# components.schemas.DocumentCreateShared.properties.bestandsdelen.description
De verwachte bestandsdelen/chunks om de bestandsinhoud te uploaden. Deze zijn afgeleid uit de opgegeven totale bestandsgrootte (`bestandsomvang`) in de body van de document-create-operatie.

# components.schemas.DocumentIdentifier.properties.kenmerk.description
De identificatie die (samen met de bron) het document uniek herleidbaar maakt.

# components.schemas.DocumentIdentifier.properties.bron.description
Geeft aan in welk systeem het kenmerk leeft en waar het vandaan komt.

# components.schemas.DocumentStatus.properties.documentUploadVoltooid.description
Geeft aan of alle bestandsdelen van het bestand ontvangen zijn en het document ontgrendeld en klaar voor gebruik is in de achterliggende Documenten-API.

# components.schemas.DocumentUpdate.description
Manage updates to metadata of Documents.

# components.schemas.DocumentUpdate.properties.publicatie.description
De unieke identificatie van de publicatie.

# components.schemas.DocumentUpdate.properties.kenmerken.description
De set aan identificatiekenmerken horend bij dit document.

# components.schemas.DocumentUpdate.properties.publicatiestatus.description
Tijdens het aanmaken wordt de publicatiestatus overgenomen van het publicatie. De publicatie kan niet zelf ingevuld worden.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.DocumentUpdate.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.DocumentUpdate.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.DocumentUpdate.properties.creatiedatum.description
De datum waarop het document ontstaan is. Niet te verwarren met de registratiedatum - de creatiedatum valt typisch *voor* de registratiedatum.

# components.schemas.DocumentUpdate.properties.ontvangstdatum.description
Indien van toepassing, datum wanneer het document door of namens de organisatie in ontvangst is genomen.

# components.schemas.DocumentUpdate.properties.datumOndertekend.description
Indien van toepassing, datum waarop het document (door alle partijen) ondertekend is.

# components.schemas.DocumentUpdate.properties.bestandsformaat.description
TODO - placeholder accepting anything, in the future this will be validated against a reference value list.

# components.schemas.DocumentUpdate.properties.bestandsnaam.description
Bestandsnaam 'op de harde schijf' van het document, bijvoorbeeld 'gelakt-verslag.pdf'.

# components.schemas.DocumentUpdate.properties.bestandsomvang.description
Bestandsgrootte op de harde schijf, in bytes.

# components.schemas.DocumentUpdate.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.DocumentUpdate.properties.registratiedatum.description
Systeemdatum en -tijd wanneer het document in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.DocumentUpdate.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer het document laatst gewijzigd is in de database.

# components.schemas.DocumentUpdate.properties.uploadVoltooid.description
Geeft aan of alle bestandsdelen van het bestand ontvangen zijn en het document ontgrendeld en klaar voor gebruik is in de achterliggende Documenten-API.

# components.schemas.Eigenaar.properties.identifier.description
De (unieke) identificatie waarmee de gebruiker die de actie uitvoert achterhaald kan worden.

# components.schemas.EigenaarGroep.properties.identifier.description
De (unieke) identificatie waarmee de gebruiker (groep) die de actie uitvoert achterhaald kan worden.

# components.schemas.EigenaarGroep.properties.weergaveNaam.description
De weergavenaam van de organisatie-eenheid.

# components.schemas.FilePart.properties.uuid.description
Het unieke ID van een bestandsdeel horend bij een document.

# components.schemas.FilePart.properties.url.description
Endpoint waar het bestandsdeel geüpload moet worden.

# components.schemas.FilePart.properties.volgnummer.description
Index van het bestandsdeel, geeft aan welk bestandsdeel precies geüpload wordt.

# components.schemas.FilePart.properties.omvang.description
Bestandsdeelomvang, in bytes. Grote bestanden moeten in meerdere stukken gesplitst worden, waarbij voor elk stuk een bepaalde bestandsgrootte verwacht wordt (deze grootte is ingesteld op de Documenten-API-server). Een bestandsdeel is pas voltooid als er binaire data van precies deze omvang geüpload zijn.

# components.schemas.FilePart.properties.inhoud.description
De binaire data van dit stuk, dit wordt doorgezet naar de achterliggende Documenten-API. De bestandsgrootte moet overeenkomen met de `omvang` van het bestandsdeel.

# components.schemas.InformationCategory.properties.identifier.description
De unieke IRI waarmee deze categorie gedefinieerd is in de overheid.nl waardelijst. Voor zelf-toegevoegde items wordt een identificatie gegenereerd.

# components.schemas.InformationCategory.properties.omschrijving.description
De beknopte toelichting die aan medewerkers en burgers getoond wordt.

# components.schemas.InformationCategory.properties.oorsprong.description
Geeft aan waar de categorie gedefinieerd is, waar de gegevens opgehaald worden en hoe de identificatie dient geïnterpreteerd te worden. Als een waardelijst als oorsprong gebruikt wordt, dan kan de categorie niet bewerkt of verwijderd worden.

* `waardelijst` - Waardelijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# components.schemas.InformationCategory.properties.order.description
Heeft invloed op de (standaard-)sortering van categorieën in de resultaten.

# components.schemas.InformationCategoryOorsprongEnum.description
* `waardelijst` - Waardelijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# components.schemas.Organisation.properties.identifier.description
De unieke IRI waarmee deze organisatie gedefinieerd is in de overheid.nl waardelijsten. Voor zelf-toegevoegde items wordt een identificatie gegenereerd.

# components.schemas.Organisation.properties.naam.description
De naam van de organisatie (deze kan enkel gewijzigd worden als de `oorsprong` `zelf_toegevoegd` is).

# components.schemas.Organisation.properties.oorsprong.description
Geeft aan waar de organisatie gedefinieerd is, waar de gegevens opgehaald worden en hoe de identificatie dient geïnterpreteerd te worden. Als een waardelijst als oorsprong gebruikt wordt, dan kan de organisatie niet bewerkt of verwijderd worden.

* `gemeentelijst` - Register gemeenten compleet
* `solijst` - Register samenwerkingsorganisaties compleet
* `oorglijst` - Register overige overheidsorganisaties compleet
* `caribischelijst` - Caribische organisaties
* `provincielijst` - Provincielijst
* `waterschaplijst` - Waterschaplijst
* `zbolijst` - ZBO-lijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# components.schemas.Organisation.properties.isActief.description
Geeft de actief-status van de organisatie aan.

# components.schemas.OrganisationOorsprongEnum.description
* `gemeentelijst` - Register gemeenten compleet
* `solijst` - Register samenwerkingsorganisaties compleet
* `oorglijst` - Register overige overheidsorganisaties compleet
* `caribischelijst` - Caribische organisaties
* `provincielijst` - Provincielijst
* `waterschaplijst` - Waterschaplijst
* `zbolijst` - ZBO-lijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# components.schemas.OrganisationUnit.properties.identifier.description
De (unieke) identificatie waarmee de organisatie-eenheid die de actie uitvoert achterhaald kan worden.

# components.schemas.OrganisationUnit.properties.naam.description
De weergavenaam van de organisatie-eenheid.

# components.schemas.PatchedDocumentUpdate.description
Manage updates to metadata of Documents.

# components.schemas.PatchedDocumentUpdate.properties.publicatie.description
De unieke identificatie van de publicatie.

# components.schemas.PatchedDocumentUpdate.properties.kenmerken.description
De set aan identificatiekenmerken horend bij dit document.

# components.schemas.PatchedDocumentUpdate.properties.publicatiestatus.description
Tijdens het aanmaken wordt de publicatiestatus overgenomen van het publicatie. De publicatie kan niet zelf ingevuld worden.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PatchedDocumentUpdate.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.PatchedDocumentUpdate.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.PatchedDocumentUpdate.properties.creatiedatum.description
De datum waarop het document ontstaan is. Niet te verwarren met de registratiedatum - de creatiedatum valt typisch *voor* de registratiedatum.

# components.schemas.PatchedDocumentUpdate.properties.ontvangstdatum.description
Indien van toepassing, datum wanneer het document door of namens de organisatie in ontvangst is genomen.

# components.schemas.PatchedDocumentUpdate.properties.datumOndertekend.description
Indien van toepassing, datum waarop het document (door alle partijen) ondertekend is.

# components.schemas.PatchedDocumentUpdate.properties.bestandsformaat.description
TODO - placeholder accepting anything, in the future this will be validated against a reference value list.

# components.schemas.PatchedDocumentUpdate.properties.bestandsnaam.description
Bestandsnaam 'op de harde schijf' van het document, bijvoorbeeld 'gelakt-verslag.pdf'.

# components.schemas.PatchedDocumentUpdate.properties.bestandsomvang.description
Bestandsgrootte op de harde schijf, in bytes.

# components.schemas.PatchedDocumentUpdate.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.PatchedDocumentUpdate.properties.registratiedatum.description
Systeemdatum en -tijd wanneer het document in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.PatchedDocumentUpdate.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer het document laatst gewijzigd is in de database.

# components.schemas.PatchedDocumentUpdate.properties.uploadVoltooid.description
Geeft aan of alle bestandsdelen van het bestand ontvangen zijn en het document ontgrendeld en klaar voor gebruik is in de achterliggende Documenten-API.

# components.schemas.PatchedOrganisation.properties.identifier.description
De unieke IRI waarmee deze organisatie gedefinieerd is in de overheid.nl waardelijsten. Voor zelf-toegevoegde items wordt een identificatie gegenereerd.

# components.schemas.PatchedOrganisation.properties.naam.description
De naam van de organisatie (deze kan enkel gewijzigd worden als de `oorsprong` `zelf_toegevoegd` is).

# components.schemas.PatchedOrganisation.properties.oorsprong.description
Geeft aan waar de organisatie gedefinieerd is, waar de gegevens opgehaald worden en hoe de identificatie dient geïnterpreteerd te worden. Als een waardelijst als oorsprong gebruikt wordt, dan kan de organisatie niet bewerkt of verwijderd worden.

* `gemeentelijst` - Register gemeenten compleet
* `solijst` - Register samenwerkingsorganisaties compleet
* `oorglijst` - Register overige overheidsorganisaties compleet
* `caribischelijst` - Caribische organisaties
* `provincielijst` - Provincielijst
* `waterschaplijst` - Waterschaplijst
* `zbolijst` - ZBO-lijst
* `zelf_toegevoegd` - Zelf-toegevoegd item

# components.schemas.PatchedOrganisation.properties.isActief.description
Geeft de actief-status van de organisatie aan.

# components.schemas.PatchedOrganisationUnit.properties.identifier.description
De (unieke) identificatie waarmee de organisatie-eenheid die de actie uitvoert achterhaald kan worden.

# components.schemas.PatchedOrganisationUnit.properties.naam.description
De weergavenaam van de organisatie-eenheid.

# components.schemas.PatchedPublicationWriteShared.description
Encapsulate the create/update validation logic and behaviour.

The publication serializer is split in read/write parts so that the output can be
properly documented in the API schema. Writes for concept publications are much
more relaxed that published publications.

The write serializer in turn is a polymorphic serializer, covering the validation
behaviour for concept/published publication states.

.. todo:: test validation behaviour of an incomplete concept publication being
changed to published.

# components.schemas.PatchedPublicationWriteShared.properties.publicatiestatus.description
**Waarschuwing**: je kan geen ingetrokken publicatie aanmaken.

**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PublicatiestatusEnum.description
**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PublicationIdentifier.properties.kenmerk.description
De identificatie die (samen met de bron) de publicatie uniek herleidbaar maakt.

# components.schemas.PublicationIdentifier.properties.bron.description
Geeft aan in welk systeem het kenmerk leeft en waar het vandaan komt.

# components.schemas.PublicationRead.description
Encapsulate the read behaviour for publication serialization.

For read operations, we're much closer to the database model and can provide
stronger guarantees about the returned data, leading to stricter schema/type
definitions.

# components.schemas.PublicationRead.properties.urlPublicatieIntern.title
Werk een publicatie (in zijn geheel) bij.

# components.schemas.PublicationRead.properties.urlPublicatieIntern.description
De URL die verwijst naar de UI van de interne applicatie waar de publicatie beheerd wordt. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.PublicationRead.properties.urlPublicatieExtern.description
De URL die verwijst naar de UI van de externe applicatie waar de publicatie publiek toegankelijk is. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.PublicationRead.properties.informatieCategorieen.description
De informatiecategorie verduidelijkt de soort informatie die in de publicatie voorkomt.

# components.schemas.PublicationRead.properties.diWooInformatieCategorieen.description
De informatiecategorieën voor in de sitemap.

# components.schemas.PublicationRead.properties.onderwerpen.description
Onderwerpen gaan over maatschappelijk relevante informatie die meerdere publicaties omvatten. Ze kunnen tientallen jaren relevant blijven en overstijgen de typische levensduur van een enkele publicatie.

# components.schemas.PublicationRead.properties.publisher.description
De organisatie die de publicatie publiceert.De 'publisher' kan `null` zijn voor conceptpublicaties.

# components.schemas.PublicationRead.properties.verantwoordelijke.description
De organisatie die verantwoordelijk is voor de publicatie en haar inhoud.

# components.schemas.PublicationRead.properties.opsteller.description
De organisatie die de publicatie en haar inhoud opgesteld heeft.

# components.schemas.PublicationRead.properties.kenmerken.description
De set aan identificatiekenmerken horend bij deze publicatie.

# components.schemas.PublicationRead.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.PublicationRead.properties.eigenaarGroep.description
Niet-verplichte organisatie-eenheid die ook eigenaar is van de publicatie, naast de `eigenaar` (op persoonlijke titel).

# components.schemas.PublicationRead.properties.publicatiestatus.description
**Waarschuwing**: je kan geen ingetrokken publicatie aanmaken.

**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PublicationRead.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.PublicationRead.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.PublicationRead.properties.registratiedatum.description
Systeemdatum en -tijd wanneer de publicatie in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.PublicationRead.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer de publicatie laatst gewijzigd is in de database.

# components.schemas.PublicationRead.properties.datumBeginGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten in werking treden.

# components.schemas.PublicationRead.properties.datumEindeGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten (zijn) komen te vervallen.

# components.schemas.PublicationRead.properties.bronBewaartermijn.description
De bron waaruit de bewaartermijn bepaald is (bjivoorbeeld: Selectielijst gemeenten 2020).

# components.schemas.PublicationRead.properties.selectiecategorie.description
De categorie waaruit de bewaartermijn bepaald is, zoals deze in de bron bewaartermijn voorkomt (bijvoorbeeld: 20.1.2).

# components.schemas.PublicationRead.properties.archiefnominatie.description
Geeft aan of de gegevens bij het archiveren bewaard blijven of definitief vernietigd worden.

* `blijvend_bewaren` - Blijvend bewaren
* `vernietigen` - Vernietigen

# components.schemas.PublicationRead.properties.archiefactiedatum.description
Datum waarop de publicatie overgebracht of definitief vernietigd zal worden.

# components.schemas.PublicationWriteShared.description
Encapsulate the create/update validation logic and behaviour.

The publication serializer is split in read/write parts so that the output can be
properly documented in the API schema. Writes for concept publications are much
more relaxed that published publications.

The write serializer in turn is a polymorphic serializer, covering the validation
behaviour for concept/published publication states.

.. todo:: test validation behaviour of an incomplete concept publication being
changed to published.

# components.schemas.PublicationWriteShared.properties.publicatiestatus.description
**Waarschuwing**: je kan geen ingetrokken publicatie aanmaken.

**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PublishedOrRevokedPublicationWrite.description
Base serializer for publication read and write operations.

This base class defines the shared logic that should be kept in sync between read
and write operations for consistent API documentation (and behaviour).

# components.schemas.PublishedOrRevokedPublicationWrite.properties.urlPublicatieIntern.title
Werk een publicatie (in zijn geheel) bij.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.urlPublicatieIntern.description
De URL die verwijst naar de UI van de interne applicatie waar de publicatie beheerd wordt. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.urlPublicatieExtern.description
De URL die verwijst naar de UI van de externe applicatie waar de publicatie publiek toegankelijk is. Dit vereist dat de algemene configuratieparameter ingevuld is, anders wordt er een lege string teruggestuurd.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.informatieCategorieen.description
De informatiecategorie verduidelijkt de soort informatie die in de publicatie voorkomt.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.diWooInformatieCategorieen.description
De informatiecategorieën voor in de sitemap.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.onderwerpen.description
Onderwerpen gaan over maatschappelijk relevante informatie die meerdere publicaties omvatten. Ze kunnen tientallen jaren relevant blijven en overstijgen de typische levensduur van een enkele publicatie.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.publisher.description
De organisatie die de publicatie publiceert.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.verantwoordelijke.description
De organisatie die verantwoordelijk is voor de publicatie en haar inhoud.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.opsteller.description
De organisatie die de publicatie en haar inhoud opgesteld heeft.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.kenmerken.description
De set aan identificatiekenmerken horend bij deze publicatie.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.eigenaar.description
De persoon die het document aangemaakt heeft, afgeleid uit de auditlogs.

**Pas op**: Als je het veld opgeeft tijdens het aanmaken of bijwerken van het object, dan zal de eigenaarinformatie afwijken van de audit headers.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.eigenaarGroep.description
Niet-verplichte organisatie-eenheid die ook eigenaar is van de publicatie, naast de `eigenaar` (op persoonlijke titel).

# components.schemas.PublishedOrRevokedPublicationWrite.properties.publicatiestatus.description
**Waarschuwing**: je kan geen ingetrokken publicatie aanmaken.

**Waarschuwing**: wanneer je een publicatie intrekt, dan worden ook de gerelateerde gepubliceerde documenten ingetrokken.

De mogelijke statuswijzigingen zijn:

* `""` -> `"concept"`
* `""` -> `"gepubliceerd"`
* `"concept"` -> `"gepubliceerd"`
* `"gepubliceerd"` -> `"ingetrokken"`.

Let op dat bij sommige wijzigingen beperkt kunnen zijn door business-logica.

* `gepubliceerd` - Gepubliceerd
* `concept` - Concept
* `ingetrokken` - Ingetrokken

# components.schemas.PublishedOrRevokedPublicationWrite.properties.gepubliceerdOp.description
Systeemdatum en -tijd wanneer de publicatie gepubliceerd werd.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.ingetrokkenOp.description
Systeemdatum en -tijd wanneer de publicatie ingetrokken werd.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.registratiedatum.description
Systeemdatum en -tijd wanneer de publicatie in de databank opgeslagen is. Niet te verwarren met de creatiedatum van de publicatie, die typisch *voor* de registratiedatum valt.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer de publicatie laatst gewijzigd is in de database.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.datumBeginGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten in werking treden.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.datumEindeGeldigheid.description
De datum waarop de rechten en plichten vastgelegd in deze documenten (zijn) komen te vervallen.

# components.schemas.PublishedOrRevokedPublicationWrite.properties.bronBewaartermijn.description
De bron waaruit de bewaartermijn bepaald is (bjivoorbeeld: Selectielijst gemeenten 2020).
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.PublishedOrRevokedPublicationWrite.properties.selectiecategorie.description
De categorie waaruit de bewaartermijn bepaald is, zoals deze in de bron bewaartermijn voorkomt (bijvoorbeeld: 20.1.2).
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.PublishedOrRevokedPublicationWrite.properties.archiefnominatie.description
Geeft aan of de gegevens bij het archiveren bewaard blijven of definitief vernietigd worden.
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

* `blijvend_bewaren` - Blijvend bewaren
* `vernietigen` - Vernietigen

# components.schemas.PublishedOrRevokedPublicationWrite.properties.archiefactiedatum.description
Datum waarop de publicatie overgebracht of definitief vernietigd zal worden.
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.PublishedOrRevokedPublicationWrite.properties.toelichtingBewaartermijn.description
**Opmerking** handmatig opgegeven waarden worden bij het aanmaken (of wanneer de informatiecategorieën bijgewerkt worden) overschreven met de automatisch afgeleide waarden uit de gekoppelde informatiecategorie(ën).

# components.schemas.RetrieveUrlDocumentCreate.properties.documentUrl.description
De bronlocatie (URL) van het document in een (externe) Documenten API. Dit moet verwijzen naar de detail-endpoint - wij bouwen vervolgens de download-URL  op. Dit veld moet opgegeven worden wanneer het `aanleveringBestand`-veld op `ophalen` staat, dit veld moet dan ook leeg zijn als het `aanleveringBestand` veld op `ontvangen` staat. Merk op dat je de `versie` query-parameter kan opnemen om naar een specifieke documentversie te verwijzen. 

# components.schemas.Theme.properties.identifier.description
De unieke IRI waarmee het thema in de overheid.nl waardenlijst gedefinieerd is. Voor zelf-toegevoegde items wordt een identificatie gegenereerd.

# components.schemas.Theme.properties.subThemes.description
De subthema's die binnen het huidige thema bestaan.

# components.schemas.Topic.properties.publicaties.description
De publicatie die aan dit onderwerp gekoppeld is.

# components.schemas.Topic.properties.promoot.description
Vlag die aangeeft of dit onderwerp gepromoot wordt in het burgerportaal.

# components.schemas.Topic.properties.registratiedatum.description
Systeemdatum en -tijd wanneer het onderwerp geregistreerd is in de database.

# components.schemas.Topic.properties.laatstGewijzigdDatum.description
Systeemdatum en -tijd wanneer het onderwerp laatst gewijzigd is in de database.

# components.schemas.VertrouwelijkheidaanduidingEnum.description
* `openbaar` - Openbaar
* `beperkt_openbaar` - Beperkt openbaar
* `intern` - Intern
* `zaakvertrouwelijk` - Zaakvertrouwelijk
* `vertrouwelijk` - Vertrouwelijk
* `confidentieel` - Confidentieel
* `geheim` - Geheim
* `zeer_geheim` - Zeer geheim

# components.securitySchemes.tokenAuth.description
Token-based authentication with required prefix "Token"