DIGITAAL VLAANDEREN
Documentatie consultatie api
- Thomas De Langhe
Bevragingen
GET /audit/v1/consultaties/registraties
Online bevraging van audit events.
Request
parameter | beschrijving |
|---|---|
x-correlation-id | Referte (uuid) om meerdere request transacties te groeperen |
x-tracing-id | Referte (uuid) om de request transactie end-to-end uniek te identificeren |
x-request-id | Referte (uuid) om de http request uniek te identificeren |
register | Auditregister waarin gezocht moet worden. |
correlatieId | Referte (uuid) om meerdere request transacties te groeperen. Dit is een zoekcriterium dus het gaat hier om de correlatieId van de logrecords |
tracingId | Referte (uuid) om de request transactie end-to-end uniek te identificeren. Dit is een zoekcriterium dus het gaat hier om de tracingId van de logrecords |
finaliteiten | Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd. |
operaties | De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd. Er kan een lijst meegegeven worden gescheiden door comma’s |
gebruikers | Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account. |
startDatum | Datum vanaf wanneer auditevents opgevraagd worden |
eindDatum | Datum tot wanneer auditevents opgevraagd worden |
onderwerpen | Unieke identificatienummers van de onderwerpen, gescheiden door comma’s |
organisaties | Unieke identificatienummers van de organisaties, gescheiden door comma’s |
limit | Aantal resultaten dat moet teruggeven worden |
offset | De eerste positie van waar resultaten van de query gegeven worden. |
Response
De velden zijn dezelfde als van de registratie api: Documentatie registratie API .
Rapporten
Aanvragen van een audit rapport.
POST /audit/v1/consultaties/rapporten
Request
parameter | type | beschrijving |
|---|---|---|
x-correlation-id | header | Referte (uuid) om meerdere request transacties te groeperen |
x-tracing-id | header | Referte (uuid) om de request transactie end-to-end uniek te identificeren |
x-request-id | header | Referte (uuid) om de http request uniek te identificeren |
register | body | Auditregister waarin gezocht moet worden. |
correlatieId | body | Referte (uuid) om meerdere request transacties te groeperen. Dit is een zoekcriterium dus het gaat hier om de correlatieId van de logrecords |
tracingId | body | Referte (uuid) om de request transactie end-to-end uniek te identificeren. Dit is een zoekcriterium dus het gaat hier om de tracingId van de logrecords |
operaties | body | De uitgevoerde operatie op het onderwerp. Meestal is dit dan de dienst waarmee de vraag gesteld werd. Er kan een lijst meegegeven worden gescheiden door comma’s |
finaliteiten | body | Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd. |
gebruikers | body | Uniek identificatienummer van de natuurlijke persoon, op basis van een nationaal nummer of een andere persoonsidentificatie zoals bv. personeelsnummer of account. |
startDatum | body | Datum vanaf wanneer auditevents opgevraagd worden |
eindDatum | body | Datum tot wanneer auditevents opgevraagd worden |
onderwerpen | body | Unieke identificatienummers van de onderwerpen, gescheiden door comma’s |
organisaties | body | Unieke identificatienummers van de organisaties, gescheiden door comma’s |
Response
Id van een auditrapport.
GET /audit/v1/consultaties/rapporten/{auditRapportId}
Request
parameter | beschrijving |
|---|---|
auditRapportId | Id van een auditrapport (teruggekregen via POST /audit/v1/consultaties/rapporten) |
x-correlation-id | Referte (uuid) om meerdere request transacties te groeperen |
x-tracing-id | Referte (uuid) om de request transactie end-to-end uniek te identificeren |
x-request-id | Referte (uuid) om de http request uniek te identificeren |
Response
Auditrapport in CSV formaat. Zie hieronder een voorbeeld. De velden zijn dezelfde als in de response van GET /audit/v1/consultaties/registraties.
Eventuele arrays worden weergegeven door een horizontale | separator, zoals ook in de voorbeeld csv:
Lijsten
GET /audit/v1/consultaties/lijsten/{type}
Request
parameter | beschrijving |
|---|---|
x-correlation-id | Referte (uuid) om meerdere request transacties te groeperen |
x-tracing-id | Referte (uuid) om de request transactie end-to-end uniek te identificeren |
x-request-id | Referte (uuid) om de http request uniek te identificeren |
type | Type lijst dat moet teruggeven worden. Mogelijke waardes:
|
Response
Lijst van ofwel:
finaliteiten:
finaliteitId: Het doel waarom de operatie uitgevoerd en de informatie verwerkt werd.
finaliteitType: BESCHRIJVING of IPDC
ofwel operaties:
operatie in string formaat
ofwel registers
register in string formaat
Related pages
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen