Introductie API Keys

Het Dataplatform van de gemeente Amsterdam gaat het gebruik van een identificatie key bij het aanroepen van haar API's vanaf 1 februari 2024 verplicht stellen. Vanaf 1 februari 2024 kun je de API's van het Dataplatform niet meer zonder een key gebruiken. Vraag tijdig een key aan via dit aanvraagformulier. Doe je dit niet, dan werkt je applicatie of website vanaf 1 februari 2024 niet meer. Dit geldt voor alle API's die op deze pagina gedocumenteerd zijn.

Door de API key kunnen we contact houden met de gebruikers van onze API's. Zo kunnen we gebruikers informeren over updates. Daarnaast krijgen we hiermee inzicht in het gebruik van de API's en in wie welke dataset via de API bevraagt. Ook voor dataeigenaren is dit waardevolle informatie.

Meer info:
Pagina API key aanvragen
Technische documentatie
Vragen? Mail naar dataplatform@amsterdam.nl

Endpoints

Tabellen

Afwijking

Attribuutwaarden uit tabellen die niet voldoen aan opgestelde regels.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Samenstelling van Id uit tabel regels en datum van uitvoering
regelId String Id van de datakwaliteitsregel waarop afwijking gebaseerd is.
identificatieVeldWaarde String Waarde van het attribuut uit de brontabel met het identificerende kenmerk behorende bij afwijkening, waarmee de record terug kan worden gevonden in de brontabel.
datum Date Datum van validatie.
tabelnaam String Naam van de geanalyseerde tabel.
attrnaam String Naam van het geanalyseerde attribuut.
value String Waarde van het attribuut.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
attrnaam Tekst Test op exacte waarde (==)
attrnaam[isempty] true | false Test of de waarde leeg is (== '' / != '')
attrnaam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
attrnaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
attrnaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
attrnaam[not] Test of waarde niet overeenkomt (!=).
datum yyyy-mm-dd Test op exacte waarde (==)
datum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
datum[gt] Test op groter dan (>).
datum[lte] Test op kleiner dan of gelijk (<=).
datum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
datum[gte] Test op groter dan of gelijk (>=).
datum[not] Test of waarde niet overeenkomt (!=).
datum[lt] Test op kleiner dan (<).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
identificatieVeldWaarde Tekst Test op exacte waarde (==)
identificatieVeldWaarde[isempty] true | false Test of de waarde leeg is (== '' / != '')
identificatieVeldWaarde[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
identificatieVeldWaarde[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
identificatieVeldWaarde[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
identificatieVeldWaarde[not] Test of waarde niet overeenkomt (!=).
regelId Tekst Test op exacte waarde (==)
regelId[isempty] true | false Test of de waarde leeg is (== '' / != '')
regelId[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
regelId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
regelId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
regelId[not] Test of waarde niet overeenkomt (!=).
tabelnaam Tekst Test op exacte waarde (==)
tabelnaam[isempty] true | false Test of de waarde leeg is (== '' / != '')
tabelnaam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
tabelnaam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
tabelnaam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
tabelnaam[not] Test of waarde niet overeenkomt (!=).
value Tekst Test op exacte waarde (==)
value[isempty] true | false Test of de waarde leeg is (== '' / != '')
value[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
value[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
value[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
value[not] Test of waarde niet overeenkomt (!=).

Bronattribuut

Attributen behorende bij een brontabel.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor het attribuut behorende bij de brontabel.
brontabelid String Id van de bijbehorende brontabel.
naam String Naam van het betreffende bronattribuut .
omschrijving String Omschrijving van/toelichting op het betreffende bronattribuut.
format String Format van het betreffende bronattribuut.
referentieindicator String Indicatie of de waarden van het bronatribuut referentieverwijzingen (in een ander tabel) zijn (T) of reële waarden zijn (F).
referentietabel String Id van de referentietabel waarnaar verwezen wordt indien referentieIndicator = T of NULL indien referentieIndicator = F.
identificatieVeldIndicator String Indicatie of het attribuut de identificerende kenmerken van de brontabel bevat waarmee records met afwijkeningen eenvoudig terug kunnen worden gevonden (T) of niet (F).
filterveldindicator String Indicatie of het attribuut als filterveld beschouwd kan worden waarop geselecteerd kan worden in de monitor bij het bekijken van de afwijkingen (T) of niet (F).
status String Status van het bronattribuut (-1 = afgevoerd, 0= inactief, 1 = actief).
datum Date Datum van de statuswijziging.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
brontabelid Tekst Test op exacte waarde (==)
brontabelid[isempty] true | false Test of de waarde leeg is (== '' / != '')
brontabelid[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
brontabelid[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
brontabelid[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
brontabelid[not] Test of waarde niet overeenkomt (!=).
datum yyyy-mm-dd Test op exacte waarde (==)
datum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
datum[gt] Test op groter dan (>).
datum[lte] Test op kleiner dan of gelijk (<=).
datum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
datum[gte] Test op groter dan of gelijk (>=).
datum[not] Test of waarde niet overeenkomt (!=).
datum[lt] Test op kleiner dan (<).
filterveldindicator Tekst Test op exacte waarde (==)
filterveldindicator[isempty] true | false Test of de waarde leeg is (== '' / != '')
filterveldindicator[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
filterveldindicator[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
filterveldindicator[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
filterveldindicator[not] Test of waarde niet overeenkomt (!=).
format Tekst Test op exacte waarde (==)
format[isempty] true | false Test of de waarde leeg is (== '' / != '')
format[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
format[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
format[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
format[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
identificatieVeldIndicator Tekst Test op exacte waarde (==)
identificatieVeldIndicator[isempty] true | false Test of de waarde leeg is (== '' / != '')
identificatieVeldIndicator[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
identificatieVeldIndicator[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
identificatieVeldIndicator[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
identificatieVeldIndicator[not] Test of waarde niet overeenkomt (!=).
naam Tekst Test op exacte waarde (==)
naam[isempty] true | false Test of de waarde leeg is (== '' / != '')
naam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[not] Test of waarde niet overeenkomt (!=).
omschrijving Tekst Test op exacte waarde (==)
omschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
omschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[not] Test of waarde niet overeenkomt (!=).
referentieindicator Tekst Test op exacte waarde (==)
referentieindicator[isempty] true | false Test of de waarde leeg is (== '' / != '')
referentieindicator[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referentieindicator[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referentieindicator[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referentieindicator[not] Test of waarde niet overeenkomt (!=).
referentietabel Tekst Test op exacte waarde (==)
referentietabel[isempty] true | false Test of de waarde leeg is (== '' / != '')
referentietabel[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referentietabel[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referentietabel[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referentietabel[not] Test of waarde niet overeenkomt (!=).
status Tekst Test op exacte waarde (==)
status[isempty] true | false Test of de waarde leeg is (== '' / != '')
status[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
status[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
status[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
status[not] Test of waarde niet overeenkomt (!=).

Brondataset

Brondataset.

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor de brondataset.
naam String Naam van de betreffende brondataset.
omschrijving String Omschrijving van / toelichting op de betreffende brondataset.
bronhouder String organisatieonderdeel dat bronhouder is van de betreffende brondataset.
status Integer Status van de brondataset (-1 = afgevoerd, 0= inactief, 1 = actief).
datum Date Datum van de statuswijziging.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
bronhouder Tekst Test op exacte waarde (==)
bronhouder[isempty] true | false Test of de waarde leeg is (== '' / != '')
bronhouder[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bronhouder[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bronhouder[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bronhouder[not] Test of waarde niet overeenkomt (!=).
datum yyyy-mm-dd Test op exacte waarde (==)
datum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
datum[gt] Test op groter dan (>).
datum[lte] Test op kleiner dan of gelijk (<=).
datum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
datum[gte] Test op groter dan of gelijk (>=).
datum[not] Test of waarde niet overeenkomt (!=).
datum[lt] Test op kleiner dan (<).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
naam Tekst Test op exacte waarde (==)
naam[isempty] true | false Test of de waarde leeg is (== '' / != '')
naam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[not] Test of waarde niet overeenkomt (!=).
omschrijving Tekst Test op exacte waarde (==)
omschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
omschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[not] Test of waarde niet overeenkomt (!=).
status Geheel getal Test op exacte waarde (==)
status[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
status[gt] Test op groter dan (>).
status[lte] Test op kleiner dan of gelijk (<=).
status[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
status[gte] Test op groter dan of gelijk (>=).
status[not] Test of waarde niet overeenkomt (!=).
status[lt] Test op kleiner dan (<).

Brontabel

Brontabel

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor de tabel behorende bij de brondataset.
bronDatasetId String Id van de bijbehorende brondataset.
naam String Naam van de betreffende brontabel.
omschrijving String Omschrijving van / toelichting op de betreffende brontabel.
type Integer Type brontabel: O = tabel met objectgegevens, R = tabel met referentie-/ domeinwaardegegevens.
dataProfileringFrequentie Integer Frequentie waarmee de dataprofilingqueries voor betreffende brontabel worden gedraaid (1=dagelijks, 2=wekelijks, 3=maandelijks, 4=kwartaal, 5 = jaarlijks).
frequentie Integer Indien type is 'O', frequentie waarmee de datakwaliteitqueries voor betreffende brontabel worden gedraaid (1=dagelijks, 2=wekelijks, 3=maandelijks, 4=kwartaal, 5 =jaarlijks).
status Integer Status van de brontabel (-1 = afgevoerd/end of life van de tabel, 0= inactief/queries worden tijdelijk niet uitgevoerd, 1 = actief/queries worden conform frequentie uitgevoerd).
datum Date Datum van de statuswijziging.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
bronDatasetId Tekst Test op exacte waarde (==)
bronDatasetId[isempty] true | false Test of de waarde leeg is (== '' / != '')
bronDatasetId[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bronDatasetId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bronDatasetId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bronDatasetId[not] Test of waarde niet overeenkomt (!=).
dataProfileringFrequentie Geheel getal Test op exacte waarde (==)
dataProfileringFrequentie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dataProfileringFrequentie[gt] Test op groter dan (>).
dataProfileringFrequentie[lte] Test op kleiner dan of gelijk (<=).
dataProfileringFrequentie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dataProfileringFrequentie[gte] Test op groter dan of gelijk (>=).
dataProfileringFrequentie[not] Test of waarde niet overeenkomt (!=).
dataProfileringFrequentie[lt] Test op kleiner dan (<).
datum yyyy-mm-dd Test op exacte waarde (==)
datum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
datum[gt] Test op groter dan (>).
datum[lte] Test op kleiner dan of gelijk (<=).
datum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
datum[gte] Test op groter dan of gelijk (>=).
datum[not] Test of waarde niet overeenkomt (!=).
datum[lt] Test op kleiner dan (<).
frequentie Geheel getal Test op exacte waarde (==)
frequentie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
frequentie[gt] Test op groter dan (>).
frequentie[lte] Test op kleiner dan of gelijk (<=).
frequentie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
frequentie[gte] Test op groter dan of gelijk (>=).
frequentie[not] Test of waarde niet overeenkomt (!=).
frequentie[lt] Test op kleiner dan (<).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
naam Tekst Test op exacte waarde (==)
naam[isempty] true | false Test of de waarde leeg is (== '' / != '')
naam[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
naam[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
naam[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
naam[not] Test of waarde niet overeenkomt (!=).
omschrijving Tekst Test op exacte waarde (==)
omschrijving[isempty] true | false Test of de waarde leeg is (== '' / != '')
omschrijving[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
omschrijving[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
omschrijving[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
omschrijving[not] Test of waarde niet overeenkomt (!=).
status Geheel getal Test op exacte waarde (==)
status[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
status[gt] Test op groter dan (>).
status[lte] Test op kleiner dan of gelijk (<=).
status[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
status[gte] Test op groter dan of gelijk (>=).
status[not] Test of waarde niet overeenkomt (!=).
status[lt] Test op kleiner dan (<).
type Geheel getal Test op exacte waarde (==)
type[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
type[gt] Test op groter dan (>).
type[lte] Test op kleiner dan of gelijk (<=).
type[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
type[gte] Test op groter dan of gelijk (>=).
type[not] Test of waarde niet overeenkomt (!=).
type[lt] Test op kleiner dan (<).

Raamwerk

Kwaliteitskenmerken behorende bij de kwaliteitsdimensies

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor de kwaliteitskenmerken behorende bij de kwaliteitsdimensies .
dimensie String Naam van de kwaliteitsdimensie uit NORA.
kenmerk String Naam van het kwaliteitskenmerk dat behoort bij betreffende kwaliteitsdimensie.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
dimensie Tekst Test op exacte waarde (==)
dimensie[isempty] true | false Test of de waarde leeg is (== '' / != '')
dimensie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dimensie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dimensie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
dimensie[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
kenmerk Tekst Test op exacte waarde (==)
kenmerk[isempty] true | false Test of de waarde leeg is (== '' / != '')
kenmerk[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
kenmerk[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
kenmerk[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
kenmerk[not] Test of waarde niet overeenkomt (!=).

Regel

Datakwaliteitsregels en namen van bijbehorende queries

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor de datakwaliteitsregel en naam van de bijbehorende query.
raamwerkId String Id van het kwaliteitskenmerk waar de datakwaliteitsregel betrekking op heeft
bronAttribuutId String Id van het bronattribuut waar de datakwaliteitsregel betrekking op heeft.
tekst String De beschrijving van de datakwaliteitsregel.
referentie String De conditie (subselectie) waaraan de instanties (records) moeten voldoen waarvoor de datakwalteitsregel hoort te gelden.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
bronAttribuutId Tekst Test op exacte waarde (==)
bronAttribuutId[isempty] true | false Test of de waarde leeg is (== '' / != '')
bronAttribuutId[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
bronAttribuutId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
bronAttribuutId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
bronAttribuutId[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).
raamwerkId Tekst Test op exacte waarde (==)
raamwerkId[isempty] true | false Test of de waarde leeg is (== '' / != '')
raamwerkId[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
raamwerkId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
raamwerkId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
raamwerkId[not] Test of waarde niet overeenkomt (!=).
referentie Tekst Test op exacte waarde (==)
referentie[isempty] true | false Test of de waarde leeg is (== '' / != '')
referentie[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
referentie[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
referentie[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
referentie[not] Test of waarde niet overeenkomt (!=).
tekst Tekst Test op exacte waarde (==)
tekst[isempty] true | false Test of de waarde leeg is (== '' / != '')
tekst[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
tekst[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
tekst[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
tekst[not] Test of waarde niet overeenkomt (!=).

Validatie

Bijhouding van aantallen objecten die getoetst zijn aan datakwaliteitsregels

De volgende velden zijn beschikbaar:

Veldnaam Type Identifier Omschrijving
id String ☑ Uniek identificerend kenmerk voor de datakwaliteitsregel en naam van de bijbehorende query.
dqRegelId String Id van de datakwaliteitsregel waarop gevalideerd is.
aantalValideRecords Integer Aantal instanties (records) die voldoen aan de datakwaliteitsregel.
aantalReferentieRecords Integer Het totaal aantal instanties (records) die gevalideerd zijn op basis van de conditie behorende bij de datakwaliteitsregel
dqDatum Date Datum van de validatie.

De volgende query-parameters zijn te gebruiken:

Parameter Autorisatie Mogelijke waarden Werking
aantalReferentieRecords Geheel getal Test op exacte waarde (==)
aantalReferentieRecords[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
aantalReferentieRecords[gt] Test op groter dan (>).
aantalReferentieRecords[lte] Test op kleiner dan of gelijk (<=).
aantalReferentieRecords[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
aantalReferentieRecords[gte] Test op groter dan of gelijk (>=).
aantalReferentieRecords[not] Test of waarde niet overeenkomt (!=).
aantalReferentieRecords[lt] Test op kleiner dan (<).
aantalValideRecords Geheel getal Test op exacte waarde (==)
aantalValideRecords[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
aantalValideRecords[gt] Test op groter dan (>).
aantalValideRecords[lte] Test op kleiner dan of gelijk (<=).
aantalValideRecords[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
aantalValideRecords[gte] Test op groter dan of gelijk (>=).
aantalValideRecords[not] Test of waarde niet overeenkomt (!=).
aantalValideRecords[lt] Test op kleiner dan (<).
dqDatum yyyy-mm-dd Test op exacte waarde (==)
dqDatum[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dqDatum[gt] Test op groter dan (>).
dqDatum[lte] Test op kleiner dan of gelijk (<=).
dqDatum[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dqDatum[gte] Test op groter dan of gelijk (>=).
dqDatum[not] Test of waarde niet overeenkomt (!=).
dqDatum[lt] Test op kleiner dan (<).
dqRegelId Tekst Test op exacte waarde (==)
dqRegelId[isempty] true | false Test of de waarde leeg is (== '' / != '')
dqRegelId[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
dqRegelId[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
dqRegelId[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
dqRegelId[not] Test of waarde niet overeenkomt (!=).
id Tekst Test op exacte waarde (==)
id[isempty] true | false Test of de waarde leeg is (== '' / != '')
id[isnull] true | false Test op ontbrekende waarden (IS NULL / IS NOT NULL).
id[in] Lijst van waarden Test of de waarde overeenkomst met 1 van de opties (IN).
id[like] Tekst met jokertekens (* en ?). Test op gedeelte van tekst.
id[not] Test of waarde niet overeenkomt (!=).