Het Dataplatform van gemeente Amsterdam gaat het gebruik van een API key bij het gebruik van API's verplicht stellen. Hiermee wil het Dataplatform inzicht krijgen wie gebruik maakt van haar APIs, zodat het Dataplatform kan communiceren over updates en wijzigingen in de API's. Eventuele wijzigingen in de API's kunnen dan tijdig geïmplementeerd worden in uw systemen. Dit gaat gelden voor alle zogenaamde 'DSO API's' van het Dataplatform van gemeente Amsterdam.
Het gebruik van een API key bij de aanroep van een API van het Dataplatform van gemeente Amsterdam is vanaf half september optioneel. In overleg met de dataorganisatie wordt een deadline vastgesteld voor het moment vanaf wanneer de API keys verplicht worden. U kunt de API's van het Dataplatform dan niet meer gebruiken zonder een API key mee te geven.
Dit heeft gevolgen voor uw systemen!
Vraag tijdig een API key aan om uw systemen hierop aan te passen. U kunt met dit formulier een API key aanvragen.
Datakwaliteit
Dataset waarin de kwaliteit van de CMS(Container Management Systeem) data is vastgelegd.
- ID:
- datakwaliteit
- Versie:
- None
- Autorisatie:
- Geen; dit is openbare data.
- Licentie:
- openbaar, tenzij anders aangegeven / behoudens uitzonderingen
- Eigenaar:
- Team BOR
- Uitgever:
- Datateam Beheer Openbare Ruimte
- Productie:
- Datateam BOR
- Bronhouder:
- Team BOR
Endpoints
- REST OpenAPI:
- /v1/datakwaliteit
Tabellen
Afwijking
Attribuutwaarden uit tabellen die niet voldoen aan opgestelde regels.
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/afwijking
- CSV-export:
- /v1/datakwaliteit/afwijking?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/afwijking?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
attrnaam[not]
|
Test of waarde niet overeenkomt (!=). |
||
attrnaam[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
attrnaam[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]
|
Test op groter dan (>). |
||
datum[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
datum[lt]
|
Test op kleiner dan (<). |
||
datum[not]
|
Test of waarde niet overeenkomt (!=). |
||
datum[lte]
|
Test op kleiner dan of gelijk (<=). |
||
datum[gte]
|
Test op groter dan of gelijk (>=). |
||
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
identificatieVeldWaarde
|
Tekst | Test op exacte waarde (==) |
|
identificatieVeldWaarde[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
identificatieVeldWaarde[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
identificatieVeldWaarde[not]
|
Test of waarde niet overeenkomt (!=). |
||
identificatieVeldWaarde[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
identificatieVeldWaarde[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
regelId
|
Tekst | Test op exacte waarde (==) |
|
regelId[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
regelId[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
regelId[not]
|
Test of waarde niet overeenkomt (!=). |
||
regelId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
regelId[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
tabelnaam
|
Tekst | Test op exacte waarde (==) |
|
tabelnaam[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
tabelnaam[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
tabelnaam[not]
|
Test of waarde niet overeenkomt (!=). |
||
tabelnaam[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
tabelnaam[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
value
|
Tekst | Test op exacte waarde (==) |
|
value[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
value[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
value[not]
|
Test of waarde niet overeenkomt (!=). |
||
value[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
value[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Bronattribuut
Attributen behorende bij een brontabel.
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/bronattribuut
- CSV-export:
- /v1/datakwaliteit/bronattribuut?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/bronattribuut?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
brontabelid[not]
|
Test of waarde niet overeenkomt (!=). |
||
brontabelid[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
brontabelid[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]
|
Test op groter dan (>). |
||
datum[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
datum[lt]
|
Test op kleiner dan (<). |
||
datum[not]
|
Test of waarde niet overeenkomt (!=). |
||
datum[lte]
|
Test op kleiner dan of gelijk (<=). |
||
datum[gte]
|
Test op groter dan of gelijk (>=). |
||
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
filterveldindicator[not]
|
Test of waarde niet overeenkomt (!=). |
||
filterveldindicator[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
filterveldindicator[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
format
|
Tekst | Test op exacte waarde (==) |
|
format[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
format[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
format[not]
|
Test of waarde niet overeenkomt (!=). |
||
format[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
format[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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
identificatieVeldIndicator
|
Tekst | Test op exacte waarde (==) |
|
identificatieVeldIndicator[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
identificatieVeldIndicator[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
identificatieVeldIndicator[not]
|
Test of waarde niet overeenkomt (!=). |
||
identificatieVeldIndicator[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
identificatieVeldIndicator[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
naam
|
Tekst | Test op exacte waarde (==) |
|
naam[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
naam[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
naam[not]
|
Test of waarde niet overeenkomt (!=). |
||
naam[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
naam[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
omschrijving
|
Tekst | Test op exacte waarde (==) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
omschrijving[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
omschrijving[not]
|
Test of waarde niet overeenkomt (!=). |
||
omschrijving[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
omschrijving[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
referentieindicator
|
Tekst | Test op exacte waarde (==) |
|
referentieindicator[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
referentieindicator[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
referentieindicator[not]
|
Test of waarde niet overeenkomt (!=). |
||
referentieindicator[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
referentieindicator[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
referentietabel
|
Tekst | Test op exacte waarde (==) |
|
referentietabel[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
referentietabel[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
referentietabel[not]
|
Test of waarde niet overeenkomt (!=). |
||
referentietabel[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
referentietabel[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
status
|
Tekst | Test op exacte waarde (==) |
|
status[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
status[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
status[not]
|
Test of waarde niet overeenkomt (!=). |
||
status[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
status[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Brondataset
Brondataset.
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/brondataset
- CSV-export:
- /v1/datakwaliteit/brondataset?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/brondataset?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
bronhouder[not]
|
Test of waarde niet overeenkomt (!=). |
||
bronhouder[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
bronhouder[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]
|
Test op groter dan (>). |
||
datum[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
datum[lt]
|
Test op kleiner dan (<). |
||
datum[not]
|
Test of waarde niet overeenkomt (!=). |
||
datum[lte]
|
Test op kleiner dan of gelijk (<=). |
||
datum[gte]
|
Test op groter dan of gelijk (>=). |
||
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
naam
|
Tekst | Test op exacte waarde (==) |
|
naam[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
naam[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
naam[not]
|
Test of waarde niet overeenkomt (!=). |
||
naam[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
naam[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
omschrijving
|
Tekst | Test op exacte waarde (==) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
omschrijving[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
omschrijving[not]
|
Test of waarde niet overeenkomt (!=). |
||
omschrijving[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
omschrijving[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
status
|
Geheel getal | Test op exacte waarde (==) |
|
status[gt]
|
Test op groter dan (>). |
||
status[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
status[lt]
|
Test op kleiner dan (<). |
||
status[not]
|
Test of waarde niet overeenkomt (!=). |
||
status[lte]
|
Test op kleiner dan of gelijk (<=). |
||
status[gte]
|
Test op groter dan of gelijk (>=). |
||
status[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Brontabel
Brontabel
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/brontabel
- CSV-export:
- /v1/datakwaliteit/brontabel?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/brontabel?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
bronDatasetId[not]
|
Test of waarde niet overeenkomt (!=). |
||
bronDatasetId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
bronDatasetId[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
dataProfileringFrequentie
|
Geheel getal | Test op exacte waarde (==) |
|
dataProfileringFrequentie[gt]
|
Test op groter dan (>). |
||
dataProfileringFrequentie[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
dataProfileringFrequentie[lt]
|
Test op kleiner dan (<). |
||
dataProfileringFrequentie[not]
|
Test of waarde niet overeenkomt (!=). |
||
dataProfileringFrequentie[lte]
|
Test op kleiner dan of gelijk (<=). |
||
dataProfileringFrequentie[gte]
|
Test op groter dan of gelijk (>=). |
||
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]
|
Test op groter dan (>). |
||
datum[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
datum[lt]
|
Test op kleiner dan (<). |
||
datum[not]
|
Test of waarde niet overeenkomt (!=). |
||
datum[lte]
|
Test op kleiner dan of gelijk (<=). |
||
datum[gte]
|
Test op groter dan of gelijk (>=). |
||
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]
|
Test op groter dan (>). |
||
frequentie[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
frequentie[lt]
|
Test op kleiner dan (<). |
||
frequentie[not]
|
Test of waarde niet overeenkomt (!=). |
||
frequentie[lte]
|
Test op kleiner dan of gelijk (<=). |
||
frequentie[gte]
|
Test op groter dan of gelijk (>=). |
||
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
naam
|
Tekst | Test op exacte waarde (==) |
|
naam[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
naam[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
naam[not]
|
Test of waarde niet overeenkomt (!=). |
||
naam[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
naam[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
omschrijving
|
Tekst | Test op exacte waarde (==) |
|
omschrijving[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
omschrijving[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
omschrijving[not]
|
Test of waarde niet overeenkomt (!=). |
||
omschrijving[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
omschrijving[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
status
|
Geheel getal | Test op exacte waarde (==) |
|
status[gt]
|
Test op groter dan (>). |
||
status[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
status[lt]
|
Test op kleiner dan (<). |
||
status[not]
|
Test of waarde niet overeenkomt (!=). |
||
status[lte]
|
Test op kleiner dan of gelijk (<=). |
||
status[gte]
|
Test op groter dan of gelijk (>=). |
||
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]
|
Test op groter dan (>). |
||
type[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
type[lt]
|
Test op kleiner dan (<). |
||
type[not]
|
Test of waarde niet overeenkomt (!=). |
||
type[lte]
|
Test op kleiner dan of gelijk (<=). |
||
type[gte]
|
Test op groter dan of gelijk (>=). |
||
type[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Raamwerk
Kwaliteitskenmerken behorende bij de kwaliteitsdimensies
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/raamwerk
- CSV-export:
- /v1/datakwaliteit/raamwerk?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/raamwerk?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
dimensie[not]
|
Test of waarde niet overeenkomt (!=). |
||
dimensie[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
dimensie[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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
kenmerk
|
Tekst | Test op exacte waarde (==) |
|
kenmerk[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
kenmerk[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
kenmerk[not]
|
Test of waarde niet overeenkomt (!=). |
||
kenmerk[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
kenmerk[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Regel
Datakwaliteitsregels en namen van bijbehorende queries
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/regel
- CSV-export:
- /v1/datakwaliteit/regel?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/regel?_format=geojson
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
bronAttribuutId[not]
|
Test of waarde niet overeenkomt (!=). |
||
bronAttribuutId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
bronAttribuutId[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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
raamwerkId
|
Tekst | Test op exacte waarde (==) |
|
raamwerkId[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
raamwerkId[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
raamwerkId[not]
|
Test of waarde niet overeenkomt (!=). |
||
raamwerkId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
raamwerkId[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
referentie
|
Tekst | Test op exacte waarde (==) |
|
referentie[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
referentie[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
referentie[not]
|
Test of waarde niet overeenkomt (!=). |
||
referentie[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
referentie[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
|
tekst
|
Tekst | Test op exacte waarde (==) |
|
tekst[like]
|
Tekst met jokertekens (* en ?). |
Test op gedeelte van tekst. | |
tekst[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
tekst[not]
|
Test of waarde niet overeenkomt (!=). |
||
tekst[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
tekst[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |
Validatie
Bijhouding van aantallen objecten die getoetst zijn aan datakwaliteitsregels
- Autorisatie:
- Geen; dit is openbare data.
- REST URI:
- /v1/datakwaliteit/validatie
- CSV-export:
- /v1/datakwaliteit/validatie?_format=csv
- GeoJSON-export:
- /v1/datakwaliteit/validatie?_format=geojson
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]
|
Test op groter dan (>). |
||
aantalReferentieRecords[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
aantalReferentieRecords[lt]
|
Test op kleiner dan (<). |
||
aantalReferentieRecords[not]
|
Test of waarde niet overeenkomt (!=). |
||
aantalReferentieRecords[lte]
|
Test op kleiner dan of gelijk (<=). |
||
aantalReferentieRecords[gte]
|
Test op groter dan of gelijk (>=). |
||
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]
|
Test op groter dan (>). |
||
aantalValideRecords[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
aantalValideRecords[lt]
|
Test op kleiner dan (<). |
||
aantalValideRecords[not]
|
Test of waarde niet overeenkomt (!=). |
||
aantalValideRecords[lte]
|
Test op kleiner dan of gelijk (<=). |
||
aantalValideRecords[gte]
|
Test op groter dan of gelijk (>=). |
||
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]
|
Test op groter dan (>). |
||
dqDatum[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
dqDatum[lt]
|
Test op kleiner dan (<). |
||
dqDatum[not]
|
Test of waarde niet overeenkomt (!=). |
||
dqDatum[lte]
|
Test op kleiner dan of gelijk (<=). |
||
dqDatum[gte]
|
Test op groter dan of gelijk (>=). |
||
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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
dqRegelId[not]
|
Test of waarde niet overeenkomt (!=). |
||
dqRegelId[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
dqRegelId[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[isnull]
|
true | false |
Test op ontbrekende waarden (IS NULL / IS NOT NULL). |
|
id[not]
|
Test of waarde niet overeenkomt (!=). |
||
id[isempty]
|
true | false |
Test of de waarde leeg is (== '' / != '') |
|
id[in]
|
Lijst van waarden | Test of de waarde overeenkomst met 1 van de opties (IN). |