Flow status ticketing service

Open

Veld ‘metadata’

Wanneer er een actie wordt uitgevoerd in de edit API’s dan bestaat de inhoud van het veld metadata in het ticket uit de volgende velden :

• action

• objectId

• registry

• aggregateId

• Uitzondering: De edit API ‘Stel een straatnaam voor’, 'Stel een adres voor', 'Heradresseren van adressen binnen éénzelfde straatnaam of naar een andere straatnaam' en 'Plan een gebouweenheid in' hebben het veld ‘objectId’ niet.

Betekenis velden:

• action: De naam van de uitgevoerde actie.

• objectId: Het objectId van het meegegeven of nieuwe object.

• registry: In welk register deze actie zich bevindt.

• aggregateId: In het domein gedreven ontwerp (DDD) betekent een "aggregaat" een groep van objecten die bij elkaar horen en samenwerken om een bepaalde taak uit te voeren. Dit aggregaat is een soort "pakketje" van objecten die samenwerken en als één geheel worden beheerd. Het idee hierachter is dat het aggregaat zorgt voor consistentie en dat alle veranderingen die binnen het aggregaat plaatsvinden als één geheel worden opgeslagen of teruggedraaid. Dit zorgt voor een duidelijke grens voor de buitenwereld, waarbij alle communicatie met de objecten binnen het aggregaat plaatsvindt via één centraal punt. Deze structuur helpt bij het organiseren van complexe bedrijfsprocessen en zorgt ervoor dat verschillende objecten binnen het systeem beter kunnen worden beheerd. Dit zorgt voor meer flexibiliteit en onderhoudbaarheid van de software, wat uiteindelijk kan leiden tot betere prestaties en efficiëntie.

Veld ‘result’

Wanneer het ticket als status ‘complete’ heeft dan bestaat het veld ‘result’ uit een json met de volgende waarden:

• Location: De URL naar het detail van het objectId.

• ETag: De nieuwe eTag die het objectId heeft meegekregen.

Wanneer het ticket als status ‘error’ heeft dan bestaat het veld ‘result’ uit een json met de volgende waarden:

• ErrorMessage: Uitgebreide errormelding waarom het ticket de status ‘error’ heeft.

• ErrorCode: Unieke errorCode. Dit kan gebruikt om eigen errormeldingen te gebruiken. De errormelding die in het ticket staat kan ook gebruikt worden.