Skip to main content
Skip table of contents

Exposed API functies

Toelichting vooraf

Onderstaande lijst biedt een overzicht van alle endpoints en functies die beschikbaar zijn binnen de exposed API. Hiermee kan een externe applicatie informatie opvragen (GET) of aanreiken (POST). Elke functie is ook voorzien van een tag voor betere opzoekbaarheid.

Tag

Beschrijving

DossierController

Alle endpoints gerelateerd aan dossiers.

AttachmentController

Alle endpoints gerelateerd aan bijlages (attachments)

FormController

Alle endpoints gerelateerd aan formulieren.

CommunicationController

Alle endpoints gerelateerd aan communicaties.

MilestoneController

Alle endpoints gerelateerd aan mijlpalen.

TaskController

Alle endpoints gerelateerd aan taken.

Informatie opvragen (GET)

Bijlages

URI (endpoint): exposed/v1/attachments

Ter info: bijlages zijn attachments (bestanden) opgeladen door een frontoffice of backoffice gebruiker.

Bijlage metadata ophalen

Een specifieke bijlage (metadata) ophalen op basis van zijn id. Zie schema Attachment.

  • Opbouw: exposed/v1/attachments/{id}

  • Parameters:

    • id (verplicht; type path; value string)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Download bijlage bestand

Een specifieke bijlage (download) ophalen op basis van zijn id.

  • Opbouw: exposed/v1/attachments/{id}/download

  • Parameters:

    • id (verplicht; type path; value string)

  • Responses:

    • 200: success; content application/octet-stream

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Communicaties

URI (endpoint): exposed/v1/communications

Ter info: communicaties zijn e-mails of documenten aangemaakt binnen de context van het dossier.

Communicatie metadata ophalen

Een specifieke communicatie (metadata) ophalen op basis van zijn id. Zie schema Communication.

  • Opbouw: exposed/v1/communications/{id}

  • Parameters:

    • id (verplicht; type path; value string)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Communicatie als pdf ophalen

Een specifieke communicatie (pdf) ophalen op basis van zijn id.

  • Opbouw: exposed/v1/communications/{id}/pdf

  • Parameters:

    • id (verplicht; type path; value string)

  • Responses:

    • 200: success; content application/pdf

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Dossiers

URI (endpoint): exposed/v1/dossiers

Ter info: een dossier is een unieke instantie van een dossiertype.

Dossierlijst ophalen

Een resultatenlijst met dossiers ophalen. Zie schema PagedDossierList en Dossier.

  • Opbouw: exposed/v1/dossiers

  • Parameters:

    • filter (verplicht, type query, zie schema filter)

    • size (optioneel, type query, aantal dossiers op de geretourneerde pagina, int32)

    • optional (optioneel, type query, zero-based index van de geretourneerde pagina, int32)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Bijlages voor een specifiek dossier ophalen

Op basis van een dossierId alle bijlages (de metadata) in een specifiek dossier ophalen. Zie schema AttachmentList en Attachment.

  • Opbouw: exposed/v1/dossiers/{dossierId}/attachments

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Communicaties voor een specifiek dossier ophalen

Op basis van een dossierId alle communicaties in een specifiek dossier ophalen. Zie schema’s CommunicationList en Communication.

  • Opbouw: exposed/v1/dossiers/{dossierId}/communications

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Formulieren voor een specifiek dossier ophalen

Op basis van een dossierId alle formulieren in een specifiek dossier ophalen. Zie schema’s FormList en Form.

  • Opbouw: exposed/v1/dossiers/{dossierId}/forms

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Mijlpalen voor een specifiek dossier ophalen

Op basis van een dossierId alle mijlpalen in een specifiek dossier ophalen. Zie schema’s MilestoneList en Milestone.

  • Opbouw: exposed/v1/dossiers/{dossierId}/milestones

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Taken voor een specifiek dossier ophalen

Op basis van een dossierId alle taken in een specifiek dossier ophalen. Zie schema’s TaskList en Task.

  • Opbouw: exposed/v1/dossiers/{dossierId}/tasks

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Dossier metadata ophalen

Op basis van een id een specifiek dossier ophalen. Zie schema Dossier.

  • Opbouw: exposed/v1/dossiers/{id}

  • Parameters:

    • id (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Formulieren

URI (endpoint): exposed/v1/forms

Notitie: een formulier is de manier om gestructureerd gegevens vast te leggen binnen de scope van een dossier.

Formulier ophalen

Een specifiek formulier ophalen op basis van zijn id. Zie schema Form.

  • Opbouw: exposed/v1/forms/{id}

  • Parameters:

    • id (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Mijlpalen

URI (endpoint): exposed/v1/milestones

Notitie: een mijlpaal is een manier om het dossierverloop in bepaalde etappes op te delen.

Mijlpaal ophalen

Een specifieke taak ophalen op basis van zijn id. Zie schema Milestone.

  • Opbouw: exposed/v1/milestones/{id}

  • Parameters:

    • id (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Taken

URI (endpoint): exposed/v1/tasks

Ter info: een taak is een BPMN-elementtype dat een specifieke activiteit vertegenwoordigt die moet worden uitgevoerd voordat de process token verder kan.

Taak ophalen

Een specifieke taak ophalen op basis van zijn id. Zie schema Task.

  • Opbouw: exposed/v1/tasks/{id}

  • Parameters:

    • id (verplicht, type path, string value)

  • Responses:

    • 200: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Informatie aanreiken (POST)

Dossiers

URI (endpoint): exposed/v1/dossiers

Ter info: een dossier is een unieke instantie van een dossiertype.

Dossier aanmaken

Je kan een call doen om een nieuw dossier aan te maken. Hier moet je verplicht het dossiertype meegeven, en optioneel enkele extra parameters (te programmeren). Zie schema ExposedCreateDossierRequest.

  • Opbouw: exposed/v1/dossiers

  • Responses:

    • 201: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Acties uitvoeren op een dossier

Je kan een message uitsturen naar een specifiek dossier. Deze message wordt opgevangen door een message event in de workflow. Indien zich daar een process token bevindt, dan gaat deze verder binnen de workflow en volgt uitvoering van de gewenste actie. Zie schema NotifyEventActionRequest.

  • Opbouw: exposed/v1/dossiers/{dossierId}/actions

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 204: geen content

    • 400: bad request, het proces wacht momenteel niet op deze actie of message

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

Nieuwe bijlage uploaden voor een dossier

Je kan een bijlage toevoegen aan een bestaand dossier.

  • Opbouw: exposed/v1/dossiers/{dossierId}/attachments

  • Parameters:

    • dossierId (verplicht, type path, string value)

  • Responses:

    • 201: success; content application/hal+json (zie schema)

    • 404: geen resource met die id of geen toegang tot de resource; content application/json

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close