Dossierlijst ophalen
Concept
Via deze API call kan je een lijst van dossiers ophalen. Opgelet: de lijst zal enkel de dossiers bevatten waarvoor de technische gebruiker een autorisatie heeft. Via queryparameters kan je de call verder verfijnen. Zo kan je filterregels toevoegen en kan je de structuur (paginering) van de response configureren.
Sorteerregels
Specifieke sorteerregels instellen is niet mogelijk. By default zullen de dossiers gesorteerd worden volgens ‘Laatste activiteit’ (latestActivity) en dit van meest recent naar minst recent.
Filterregels
Default filterregels
De volgende filterregels zijn standaard beschikbaar binnen deze API call.
Dossierlabel (
label): string value, deze filter geeft enkel dossiers terug waarvan het dossierlabel start met de opgegeven string.Laatste mijlpaal (
lastMilestone): string value, deze filter geeft enkel dossiers terug waarvan de laatste mijlpaal exact matcht met de opgegeven key.Dossiertype (
dossierType): string value, deze filter geeft enkel dossiers terug waarvan de het dossiertype exact matcht met de opgegeven key.
Te configureren filterregels
De volgende filters werken enkel indien je extra parameters toevoegt die vertellen in welke formuliervelden je deze waardes verwacht terug te vinden.
cbeNumber: KBO-nummer (onderneming)nationalRegistryNumber: rijksregisternummer (persoon)
Opbouw extra parameters.
Voor cbeNumber:
skryv.exposed-api.dossier.filter.cbeNumbers = testForm.info.gegevensOnderneming.kboNummer, myForm .gegevensOnderneming.kboNummer
Voor nationalRegistryNumber:
skryv.exposed-api.dossier.filter.nationalRegistryNumbers = testForm.info.rijksregisternummer, myF orm.rijksregisternummer
Deze parameters bevatten een komma gescheiden lijst van paden naar de relevante velden.
Structuur van de response
Via twee parameters kan je de paginering (structuur van de response) controleren.
page: geopende pagina (default '0', d.w.z. de eerste pagina)size: maximum aantal dossiers per pagina (default ‘20’, maximum ‘100’).
Opgelet: het maximaal aantal dossiers in de response is ‘10.000’. Maak gebruik van de filterregels om onder deze limiet te bliven.
Voorbeeld
API call
Onderstaand voorbeeld vraagt de dossierlijst op en filtert op dossiers die behoren tot het dossiertype met key ‘draftDossiers’. De geretourneerde pagina mag slechts 5 dossiers bevatten en we vragen de eerste pagina op.
curl -X 'GET' \
'https://library@preview.skryv.com/exposed/v1/dossiers?dossierTypeKey=draftDossiers&size=5&page=0' \
-H 'accept: application/hal+json' \
-H 'Authorization: Bearer ***...'API response
Onderstaand voorbeeld geeft een lijst met 5 dossiers van het type ‘draftDossiers’. Voor elk dossiers zijn er geëxpliciteerde details (bijvoorbeeld de id, het label, de aanmaakdatum, een lijst met actieve taken, enzovoort) alsook gelinkte resources (bijvoorbeeld naar alle aangemaakte mijlpalen binnen het dossier) en links naar het dossier in frontoffice en backoffice.
{
"_embedded": {
"dossiers": [
{
"id": "29e73208-bedb-4561-a5f2-bad50d7cfddc",
"label": "25-SUBMITTED-0000005",
"description": "",
"dossierType": {
"id": "f01a097f-e210-459e-a8a8-5fb62b22c884",
"key": "draftDossiers",
"label": "draft dossiers"
},
"createdAt": "2025-03-21T07:04:18.186Z",
"updatedAt": "2025-03-21T07:04:31.527Z",
"activeTasks": [
{
"id": "bcd49b41-0622-11f0-bcb4-0a7fb8e3c489",
"name": "end process",
"description": "End the process",
"assignee": {
"sub": "85338aa5-720f-41c8-ae5f-09b8859d16fb",
"username": "system test",
"active": true
},
"createdAt": "2025-03-21T07:04:32Z",
"type": "POP_UP",
"active": true
}
],
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc"
},
"tasks": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc/tasks"
},
"milestones": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc/milestones"
},
"forms": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc/forms"
},
"communications": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc/communications"
},
"attachments": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/29e73208-bedb-4561-a5f2-bad50d7cfddc/attachments"
},
"backOfficeUrl": {
"href": "http://localhost:8080/#!/dossier/29e73208-bedb-4561-a5f2-bad50d7cfddc/overview"
},
"frontOfficeUrl": {
"href": "https://library-preview-eportal.skryv.com/#/dossier/29e73208-bedb-4561-a5f2-bad50d7cfddc"
}
}
},
{
"id": "029d56b6-08e8-4e81-adf0-61d4a5a6de1a",
"label": "25-SUBMITTED-0000004",
"description": "",
"dossierType": {
"id": "f01a097f-e210-459e-a8a8-5fb62b22c884",
"key": "draftDossiers",
"label": "draft dossiers"
},
"createdAt": "2025-03-19T16:58:45.552Z",
"updatedAt": "2025-03-19T16:58:45.552Z",
"activeTasks": [
{
"id": "6bcf2496-04e3-11f0-893a-0a789967407d",
"name": "Submit?",
"description": "Submit the dossier?",
"assignee": {
"sub": "7fbc4ecd-784c-41fa-b57e-4460419384e9",
"username": "Jimmy Roggeman",
"active": true
},
"createdAt": "2025-03-19T16:58:46Z",
"type": "POP_UP",
"active": true
}
],
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a"
},
"tasks": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/tasks"
},
"milestones": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/milestones"
},
"forms": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/forms"
},
"communications": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/communications"
},
"attachments": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/attachments"
},
"backOfficeUrl": {
"href": "http://localhost:8080/#!/dossier/029d56b6-08e8-4e81-adf0-61d4a5a6de1a/overview"
},
"frontOfficeUrl": {
"href": "https://library-preview-eportal.skryv.com/#/dossier/029d56b6-08e8-4e81-adf0-61d4a5a6de1a"
}
}
},
{
"id": "67046a2c-4c45-4bc0-8e52-4aec8e0438c1",
"label": "25-SUBMITTED-0000003",
"description": "",
"dossierType": {
"id": "f01a097f-e210-459e-a8a8-5fb62b22c884",
"key": "draftDossiers",
"label": "draft dossiers"
},
"createdAt": "2025-03-19T13:10:36.915Z",
"updatedAt": "2025-03-19T13:10:36.915Z",
"activeTasks": [
{
"id": "8c6b9609-04c3-11f0-bedc-0270b1861935",
"name": "Submit?",
"description": "Submit the dossier?",
"assignee": {
"sub": "85338aa5-720f-41c8-ae5f-09b8859d16fb",
"username": "system test",
"active": true
},
"createdAt": "2025-03-19T13:10:37Z",
"type": "POP_UP",
"active": true
}
],
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1"
},
"tasks": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/tasks"
},
"milestones": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/milestones"
},
"forms": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/forms"
},
"communications": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/communications"
},
"attachments": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/attachments"
},
"backOfficeUrl": {
"href": "http://localhost:8080/#!/dossier/67046a2c-4c45-4bc0-8e52-4aec8e0438c1/overview"
},
"frontOfficeUrl": {
"href": "https://library-preview-eportal.skryv.com/#/dossier/67046a2c-4c45-4bc0-8e52-4aec8e0438c1"
}
}
},
{
"id": "d4d7233c-e3bd-4522-abf8-65a640d49779",
"label": "25-SUBMITTED-0000002",
"description": "",
"dossierType": {
"id": "f01a097f-e210-459e-a8a8-5fb62b22c884",
"key": "draftDossiers",
"label": "draft dossiers"
},
"createdAt": "2025-03-19T13:10:09.885Z",
"updatedAt": "2025-03-19T13:10:09.885Z",
"activeTasks": [
{
"id": "7c500cf9-04c3-11f0-bedc-0270b1861935",
"name": "Submit?",
"description": "Submit the dossier?",
"assignee": {
"sub": "10168480-bcb3-4c38-a443-d3b2f45f704a",
"username": "Paul Janssens",
"active": true
},
"createdAt": "2025-03-19T13:10:10Z",
"type": "POP_UP",
"active": true
}
],
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779"
},
"tasks": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779/tasks"
},
"milestones": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779/milestones"
},
"forms": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779/forms"
},
"communications": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779/communications"
},
"attachments": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/d4d7233c-e3bd-4522-abf8-65a640d49779/attachments"
},
"backOfficeUrl": {
"href": "http://localhost:8080/#!/dossier/d4d7233c-e3bd-4522-abf8-65a640d49779/overview"
},
"frontOfficeUrl": {
"href": "https://library-preview-eportal.skryv.com/#/dossier/d4d7233c-e3bd-4522-abf8-65a640d49779"
}
}
},
{
"id": "72552c45-254b-4ddb-8608-dd57b72f917b",
"label": "25-SUBMITTED-0000001",
"description": "",
"dossierType": {
"id": "f01a097f-e210-459e-a8a8-5fb62b22c884",
"key": "draftDossiers",
"label": "draft dossiers"
},
"createdAt": "2025-03-19T13:09:39.076Z",
"updatedAt": "2025-03-19T13:09:39.076Z",
"activeTasks": [
{
"id": "69ff5469-04c3-11f0-bedc-0270b1861935",
"name": "Submit?",
"description": "Submit the dossier?",
"assignee": {
"sub": "7fbc4ecd-784c-41fa-b57e-4460419384e9",
"username": "Jimmy Roggeman",
"active": true
},
"createdAt": "2025-03-19T13:09:39Z",
"type": "POP_UP",
"active": true
}
],
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b"
},
"tasks": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b/tasks"
},
"milestones": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b/milestones"
},
"forms": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b/forms"
},
"communications": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b/communications"
},
"attachments": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers/72552c45-254b-4ddb-8608-dd57b72f917b/attachments"
},
"backOfficeUrl": {
"href": "http://localhost:8080/#!/dossier/72552c45-254b-4ddb-8608-dd57b72f917b/overview"
},
"frontOfficeUrl": {
"href": "https://library-preview-eportal.skryv.com/#/dossier/72552c45-254b-4ddb-8608-dd57b72f917b"
}
}
}
]
},
"_links": {
"self": {
"href": "https://library-preview.skryv.com/exposed/v1/dossiers?dossierTypeKey=draftDossiers&page=0&size=5"
}
},
"page": {
"size": 5,
"totalElements": 5,
"totalPages": 1,
"number": 0
}
}