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
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
attrnaam[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
attrnaam[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
datum
|
yyyy-mm-dd |
Test op exacte waarde (== ) |
|
datum[gt]
|
None | Test op groter dan (> ). |
|
datum[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
datum[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
datum[lt]
|
None | Test op kleiner dan (< ). |
|
datum[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
datum[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
datum[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
identificatieVeldWaarde
|
Tekst | Test op exacte waarde (== ) |
|
identificatieVeldWaarde[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
identificatieVeldWaarde[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
identificatieVeldWaarde[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
regelId
|
Tekst | Test op exacte waarde (== ) |
|
regelId[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
regelId[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
regelId[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
tabelnaam
|
Tekst | Test op exacte waarde (== ) |
|
tabelnaam[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
tabelnaam[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
tabelnaam[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
value
|
Tekst | Test op exacte waarde (== ) |
|
value[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
value[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
value[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
brontabelid[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
brontabelid[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
datum
|
yyyy-mm-dd |
Test op exacte waarde (== ) |
|
datum[gt]
|
None | Test op groter dan (> ). |
|
datum[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
datum[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
datum[lt]
|
None | Test op kleiner dan (< ). |
|
datum[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
datum[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
datum[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
filterveldindicator
|
Tekst | Test op exacte waarde (== ) |
|
filterveldindicator[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
filterveldindicator[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
filterveldindicator[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
format
|
Tekst | Test op exacte waarde (== ) |
|
format[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
format[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
format[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
identificatieVeldIndicator
|
Tekst | Test op exacte waarde (== ) |
|
identificatieVeldIndicator[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
identificatieVeldIndicator[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
identificatieVeldIndicator[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
naam
|
Tekst | Test op exacte waarde (== ) |
|
naam[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
naam[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
naam[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
omschrijving
|
Tekst | Test op exacte waarde (== ) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
omschrijving[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
omschrijving[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
referentieindicator
|
Tekst | Test op exacte waarde (== ) |
|
referentieindicator[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
referentieindicator[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
referentieindicator[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
referentietabel
|
Tekst | Test op exacte waarde (== ) |
|
referentietabel[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
referentietabel[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
referentietabel[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
status
|
Tekst | Test op exacte waarde (== ) |
|
status[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
status[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
status[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
bronhouder[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
bronhouder[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
datum
|
yyyy-mm-dd |
Test op exacte waarde (== ) |
|
datum[gt]
|
None | Test op groter dan (> ). |
|
datum[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
datum[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
datum[lt]
|
None | Test op kleiner dan (< ). |
|
datum[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
datum[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
datum[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
naam
|
Tekst | Test op exacte waarde (== ) |
|
naam[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
naam[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
naam[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
omschrijving
|
Tekst | Test op exacte waarde (== ) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
omschrijving[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
omschrijving[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
status
|
Geheel getal | Test op exacte waarde (== ) |
|
status[gt]
|
None | Test op groter dan (> ). |
|
status[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
status[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
status[lt]
|
None | Test op kleiner dan (< ). |
|
status[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
status[isnull]
|
true of 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 ). |
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
bronDatasetId[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
bronDatasetId[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
dataProfileringFrequentie
|
Geheel getal | Test op exacte waarde (== ) |
|
dataProfileringFrequentie[gt]
|
None | Test op groter dan (> ). |
|
dataProfileringFrequentie[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dataProfileringFrequentie[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
dataProfileringFrequentie[lt]
|
None | Test op kleiner dan (< ). |
|
dataProfileringFrequentie[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
dataProfileringFrequentie[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
dataProfileringFrequentie[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
datum
|
yyyy-mm-dd |
Test op exacte waarde (== ) |
|
datum[gt]
|
None | Test op groter dan (> ). |
|
datum[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
datum[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
datum[lt]
|
None | Test op kleiner dan (< ). |
|
datum[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
datum[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
datum[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
frequentie
|
Geheel getal | Test op exacte waarde (== ) |
|
frequentie[gt]
|
None | Test op groter dan (> ). |
|
frequentie[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
frequentie[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
frequentie[lt]
|
None | Test op kleiner dan (< ). |
|
frequentie[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
frequentie[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
frequentie[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
naam
|
Tekst | Test op exacte waarde (== ) |
|
naam[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
naam[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
naam[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
omschrijving
|
Tekst | Test op exacte waarde (== ) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
omschrijving[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
omschrijving[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
status
|
Geheel getal | Test op exacte waarde (== ) |
|
status[gt]
|
None | Test op groter dan (> ). |
|
status[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
status[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
status[lt]
|
None | Test op kleiner dan (< ). |
|
status[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
status[isnull]
|
true of 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 ). |
|
type
|
Geheel getal | Test op exacte waarde (== ) |
|
type[gt]
|
None | Test op groter dan (> ). |
|
type[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
type[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
type[lt]
|
None | Test op kleiner dan (< ). |
|
type[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
type[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
type[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
dimensie[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dimensie[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
kenmerk
|
Tekst | Test op exacte waarde (== ) |
|
kenmerk[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
kenmerk[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
kenmerk[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
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[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
bronAttribuutId[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
bronAttribuutId[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
raamwerkId
|
Tekst | Test op exacte waarde (== ) |
|
raamwerkId[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
raamwerkId[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
raamwerkId[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
referentie
|
Tekst | Test op exacte waarde (== ) |
|
referentie[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
referentie[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
referentie[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
tekst
|
Tekst | Test op exacte waarde (== ) |
|
tekst[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
tekst[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
tekst[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
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[gt]
|
None | Test op groter dan (> ). |
|
aantalReferentieRecords[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
aantalReferentieRecords[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
aantalReferentieRecords[lt]
|
None | Test op kleiner dan (< ). |
|
aantalReferentieRecords[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
aantalReferentieRecords[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
aantalReferentieRecords[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
aantalValideRecords
|
Geheel getal | Test op exacte waarde (== ) |
|
aantalValideRecords[gt]
|
None | Test op groter dan (> ). |
|
aantalValideRecords[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
aantalValideRecords[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
aantalValideRecords[lt]
|
None | Test op kleiner dan (< ). |
|
aantalValideRecords[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
aantalValideRecords[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
aantalValideRecords[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
dqDatum
|
yyyy-mm-dd |
Test op exacte waarde (== ) |
|
dqDatum[gt]
|
None | Test op groter dan (> ). |
|
dqDatum[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dqDatum[gte]
|
None | Test op groter dan of gelijk (>= ). |
|
dqDatum[lt]
|
None | Test op kleiner dan (< ). |
|
dqDatum[lte]
|
None | Test op kleiner dan of gelijk (<= ). |
|
dqDatum[isnull]
|
true of false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL ). |
|
dqDatum[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN ). |
|
dqRegelId
|
Tekst | Test op exacte waarde (== ) |
|
dqRegelId[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
dqRegelId[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
dqRegelId[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |
|
id
|
Tekst | Test op exacte waarde (== ) |
|
id[like]
|
Tekst met jokertekens (* en ? ). |
Test op gedeelte van tekst. | |
id[not]
|
None | Test of waarde niet overeenkomt (!= ). |
|
id[isnull]
|
true of 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[isempty]
|
true of false |
Test of de waarde leeg is (== '' / != '' ) |