API's voor zaakgericht werken

Release notes Catalogi API 1.3.2

In de Catalogi API 1.3.2 zijn de volgende issues verwerkt:

Expand-mechanisme toegevoegd

In de vorige release van de ZGW API’s was het expand-mechanisme alleen beschikbaar in de Zaken API. In de nieuwe release is dit mechanisme ook mogelijk gemaakt voor de hieronder genoemde andere API’s in de ZGW-familie waaronder dus ook de Catalogi API.

  • Documenten API
  • Besluiten API
  • Catalogi API

Net zoals bij de Zaken API is de expand gedefinieerd op alle relevante endpoints en kan de expand tot willekeurige diepte worden uitgevoerd.

Gerelateerde issues:

  • #2487 Zou het expand-mechanisme ook niet in de Catalogi API zelf bruikbaar moeten zijn?
  • #2507 Ik wil graag dat de Expand overal wordt toegepast en niet alleen voor de ZRC

Historiemodel

Betere documentatie historiemodel

Sinds de release van de vorige versie van de Catalogi API is er veel onduidelijkheid over het historiemodel. In deze versie is een Primer document toegevoegd waarin het historiemodel wordt uitgelegd aan de hand van diagrammen met voorbeeldberichten.

Diverse bug fixes

In de vorige release van de Catalogi API bleek het nieuwe historiemodel nog niet helemaal volwassen te zijn en kwamen er diverse bugs naar boven tijdens de implementaties. Zie hier de lijst met bugfixes die we in deze versie hebben doorgevoerd.

Allerhande issues opgelost

PUT en PATCH toegevoegd voor catalogussen

Deze essentiële operaties ontbraken in de OAS-specificatie en zijn nu toegevoegd.

Gerelateerde issues:

  • #2560 ZTC: update method for catalog

Het veld “catalogus” deprecated gemaakt in de POST/PUT/PATCH en business rule ztc-013 verwijderd

In de POST/PUT/PATCH voor Resultaattype en Roltype kan een catalogus worden meegegeven in de request. Dit is overbodig want je geeft al een zaaktype mee dat een catalogus heeft. Naar aanleiding van dit inzicht is tevens de business rule ztc-013 verwijderd.

Gerelateerde issues:

  • #2468 ZTC: onterecht catalogus in POST/PUT/PATCH voor Resultaattype en Roltype.
  • #2482 ZTC: business rule ztc-013 is vaag en moet aangescherpt.

Filtering op objecttypen verduidelijkt

Beschrijvingen van de query parameters aangepast (zie deze commit).

Gerelateerde issues:

  • #2479 ZTC 1.3 filter op status bij objecttypes zonder status onduidelijk.

Problemen met relatie resultaattype-besluittype en resultaattype-informatieobjecttype opgelost

Problemen omtrent de relaties resultaattype-besluittype en resultaattype-informatieobjecttype opgelost door beschrijvingen aan te passen en het veld “besluittypen” optioneel te maken (zie commit).

Gerelateerde issues:

  • #2467 ZTC: problemen relatie resultaattype-besluittype en resultaattype-informatieobjecttype oplossen

Business rule ztc-010 herschreven

Business rule ztc-010 was onduidelijk en is herschreven (zie deze commit).

Gerelateerde issues:

  • #2456 Business rule ztc-010 herschrijven

Per abuis verdwenen attribuut weer toegevoegd aan specificatie

In de berichten van operatie POST /besluittypen was het attribuut “zaaktypen” per ongeluk weggevallen. Dit element is in deze versie weer toegevoegd.

Gerelateerde issues:

  • #2437 ZTC 1.3 POST besluittype: wat is er met zaaktypen gebeurd.

Datum/tijd formaat voor eigenschappen duidelijk gespecificeerd

Het formaat van datum/tijd was niet scherp gespecificeerd in de beschrijvingen voor eigenschappen. Dat is nu strak getrokken.

Gerelateerde issues:

  • #1751 As a developer, I want to have standardized schema descriptions for eigenschappen.