Exposed API schema's

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

fileName

Naam van de bijlage

string

fileSize

Grootte van de bijlage in MB

integer (int64)

id

Unieke GUID voor de bijlage

string

mimeType

Bestandstype van de bijlage

string

updatedAt

Tijdsstempel ogenblik waarop de bijlage laatst is aangepast

string (date-time)

_embedded

• Attachments: dit is een array met Attachments (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

createdAt

Tijdsstempel ogenblik waarop de communicatie is aangemaakt

string (date-time)

id

Unieke GUID voor de communicatie

string

name

Naam van de communicatie

string

updatedAt

Tijdsstempel ogenblik waarop de communicatie laatst is aangepast

string (date-time)

_embedded

• Communications: dit is een array met Communications (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

activeTasks

Lijst van taken die actief zijn (aangemaakt, maar niet afgerond) binnen het dossier

array met Tasks (zie schema)

createdAt

Tijdsstempel ogenblik waarop het dossier is aangemaakt

string (date-time)

description

Tekstuele dossierbeschrijving zoals ingevoerd door gebruiker bij opstart vanuit de backoffice

string

dossierType

Verwijst naar dossiertype waarvan het dossier is afgeleid

DossierDefinition (zie schema)

id

Unieke GUID voor het dossier

string

label

Dossierlabel opgesteld volgens formattering zoals vastgelegd in de dossiertype instellingen

string

lastMilestone

Verwijst naar de laatst aangemaakte mijlpaal binnen het dossier

Milestone (zie schema)

updatedAt

Tijdsstempel ogenblik waarop het dossier laatst is aangepast

string (date-time)

id

Unieke GUID voor het dossiertype

string

key

Key van het dossiertype

string

label

Naam van het dossiertype

string

code

statuscode (bv. ‘200’)

sting

message

boodschap (bv. ‘Request successful. Server responded as required.’)

string

status

status (bv. ‘OK’)

string

dossierCreationData

Bijkomende parameters die je kan meegeven (zie schema Link)

object

dossierDefinitionKey (verplicht)

Key van het dossiertype. Verplicht mee te sturen als parameter in de call.

string

cbeNumber

Filter op KBO-nummer (onderneming). Let wel: dit vereist een extra parameter met info over welk formulierveld het KBO-nummer bevat. Zie dit voorbeeld voor meer info.

string

dossierTypeKey

Key van het dossiertype

string

label

Dossierlabel opgesteld volgens formattering zoals vastgelegd in de dossiertype instellingen

string

lastMilestoneKey

Key van het event in de workflow waarvoor een mijlpaal is geactiveerd

string

latestActivitySince

Tijdsstempel, je krijgt enkel dossiers terug waarin er na deze datum nog activiteit was

string

nationalRegistryNumber

Filter op rijksregisternummer (persoon). Let wel: dit vereist een extra parameter met info over welk formulierveld het rijksregisternummer bevat. Zie dit voorbeeld voor meer info.

string

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

attachments

Lijst van bijlages die upgeload zijn binnen de context van het formulier

array met bijlages

createdAt

Tijdsstempel ogenblik waarop het formulier is aangemaakt

string (date-time)

formContents

Dit is de inhoud van het ingevulde formulier, de structuur komt overeen met die van de opgebouwde formulierdefinitie of formuliertemplate

object

formType

Verwijst naar de formulierdefinitie of formuliertemplate

FormDefinition

id

Unieke GUID voor het formulier

string

readOnly

• true formulier heeft status ‘Alleen lezen’

• false formulier heeft status ‘editeerbaar’

boolean

updatedAt

Tijdsstempel ogenblik waarop het formulier laatst is aangepast

string (date-time)

version

Versienummer van het formulier

integer (int32)

key

Key van de formulierdefinitie of formuliertemplate

string

name

Naam of label van de formulierdefinitie of formuliertemplate

string

_embedded

• Forms: dit is een array met Forms (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

href

URL die de locatie aangeeft van de gelinkte resource.

string

hreflang

Geeft de taal of taalvariant van de gelinkte resource aan, bijvoorbeeld "en" voor Engels of "nl" voor Nederlands

string

title

Een optionele eigenschap die een titel of beschrijving van de gelinkte resource biedt

string

type

Geeft het MIME-type of het formaat van de gelinkte resource aan, zoals "application/json" of "text/html"

string

deprecation

Dit geeft aan of de link of de resource verouderd is en wanneer deze mogelijk niet meer ondersteund wordt

string

profile

Verwijst naar een specifieke profiel of standaard die de link of resource volgt. Dit kan nuttig zijn om aan te geven hoe een resource zich gedraagt of welke specificaties het volgt

string

name

Dit is de naam van de link of de gekoppelde resource

string

templated

Dit geeft aan of de link een sjabloon is (met placeholders die vervangen kunnen worden door specifieke waarden). De waarde is een boolean, wat betekent dat het ofwel true (waar) of false (onwaar) kan zijn

boolean

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

description

Tekstuele beschrijving van de mijlpaal zoals opgesteld in de dossierytpe instellingen

string

id

Unieke GUID voor de mijlpaal

string

key

Key van het event in de workflow waarvoor een mijlpaal is geactiveerd

string

reachedAt

Tijdsstempel ogenblik waarop de mijlpaal is bereikt

string (date-time)

status

Naam van de mijlpaal zoals gedefinieerd in de workflow

string

_embedded

• Milestones: array van milestones (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

metadata

Eventuele extra parameters die je wil meegeven met de request

object

name

Key van de message die je wil uitsturen naar het dossier

string

type

Type request. Voorlopig is hier slechts één optie

enum (NOTIFY_EVENT)

number

Specifieke pagina uit de resultatenlijst (zero index based, eerste pagina heeft index '0')

integer (int64)

size

Maximaal aantal elementen per pagina in de resultatenlijst

integer (int64)

totalElements

Totaal aantal elementen in de resultatenlijst

integer (int64)

totalPages

Totaal aantal pagina’s in de resultatenlijst

integer (int64)

_embedded

• Dossier: array van dossiers (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links (zie schema)

page

Pagineringsdetails voor de dossierlijst

PageMetadata (zie schema)

_links

Verwijzingen (links) naar self en gerelateerde items

Links

active

• true: de taak is actief, d.w.z. opgestart, maar nog niet afgerond

• false: de taak is inactief, d.w.z. nog niet opgestart of reeds afgerond

boolean

assignee

Gebruiker aan wie de taak is toegewezen

User (zie schema)

createdAt

Tijdsstempel ogenblik waarop de taak is aangemaakt

string (date-time)

description

Begeleidende tekst voor popup bij taken van het type bevestigingstaak

string

due

Tijdsstempel due date of opleveringsdatum, speelt een rol in toewijzing gebruikerstaken en sortering takenlijst backoffice.

string (date-time)

id

Unieke GUID voor de taak

string

name

Naam van de taak zoals gedefinieerd in de workflow

string

type

Type gebruikerstaak:

• document: formuliertaak

• communication: communicatietaak

• pop_up: bevestigingstaak

• select: bulktaak

• download: resource downloaden

• payment: betaalverzoek

enum (DOCUMENT,COMMUNICATION,POP_UP,SELECT,DOWNLOAD,PAYMENT)

_embedded

• Tasks: array van taken (zie schema)

object

_links

Verwijzingen (links) naar self en gerelateerde items

Links

active

• true: gebruiker is actief (d.w.z. kan inloggen en taken uitvoeren)

• false: gebruiker is inactief (d.w.z. kan niet inloggen, medewerker is bijvoorbeeld uit dienst)

boolean

sub

Unieke GUID voor de ingelogde gebruiker

string

username

Naam van de gebruiker

string