Hopp til hovudinnhald
digdir emblemdata.norge.no
Finn dataDel data

Beskrive tilgjengeliggjering via API

Merk: Datasettet KI-prosjekter i offentlig sektor er ikkje tilgjengeliggjort via API, så lenkene og endepunktene oppgitt for API-et i dømet under er ikkje verkelege og vil ikkje fungere. Døma her er kun meint å illustrere korleis ein API-beskriving ser ut.

For å beskrive at datasettet er tilgjengeliggjort over eit API bruker vi Datatjeneste-klassen dcat:DataService. Mye av informasjonen er tilsvarande som for Distribusjonen, men Datatjeneste har i tillegg nokre fleire obligatoriske felt.

Knytte API-et til datasettet

For å seie at datatjenesten tilbyr dataen for datasettet vi har beskrive bruker vi eigenskapen dcat:servesDataset. Merk at denne peiker frå Datatjenesten til Datasettet:

<https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> rdf:type dcat:Dataset ;
  # ...
  .

<https://data.digdir.no/datasets/ai_projects_norwegian_state_api> rdf:type dcat:DataService ;
  dcat:servesDataset <https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> ;
  .

Endepunkts-URL, kontaktpunkt, tittel og utgivar

Eigenskapen dcat:endpointURL angir endepunktet API-et er tilgjengelig på; den er obligatorisk. I tillegg er eigenskapane dcat:contactPoint, dct:title og dct:publisher obligatoriske. Her kan vi gjenbruke noko av informasjonen for Datasettet, sidan i dette tilfellet er det same utgivar og same kontaktpunkt for både datasett og API-et. Dette må du undersøkje om er tilfelle for datasettet du skal beskrive.

<https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> rdf:type dcat:Dataset ;
  # ...
  .

<https://data.digdir.no/datasets/ai_projects_norwegian_state_api> rdf:type dcat:DataService ;
  dcat:servesDataset <https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> ;
  dcat:endpointURL <https://data.digdir.no/api/ai_projects_norwegian_state> ; # fiktiv URL, fungerer ikke
  dct:title "API for oversikt over KI-prosjekter i offentlig sektor"@nb ;
  dct:publisher <https://organization-catalogue.fellesdatakatalog.digdir.no/organizations/991825827> ;
  dcat:contactPoint [
    rdf:type vcard:Organization ;
    vcard:hasEmail "kunstigintelligens@digdir.no" ;
    vcard:fn "Kunstig Intelligens Digdir" ;
  ] ;
  .

Lisens og format

Vi vil igjen seie her at datasettet er tilgjengelig med CC0-lisens. I tillegg tilbyr det fiktive API-et vårt dataen i XML- og JSON-format.

<https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> rdf:type dcat:Dataset ;
  # ...
  .

<https://data.digdir.no/datasets/ai_projects_norwegian_state_api> rdf:type dcat:DataService ;
  dcat:servesDataset <https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> ;
  # ...
  dct:license <http://publications.europa.eu/resource/authority/licence/CC0> ;
  dct:format <http://publications.europa.eu/resource/authority/file-type/XML> ,
             <http://publications.europa.eu/resource/authority/file-type/JSON> ;
  .

Komplett beskrivelse av datatjeneste

Heile beskrivinga av Datatjenesten/API-et ser då slik ut:

@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix foaf: <http://xmlns.com/foaf/0.1/> .
@prefix dcat: <http://www.w3.org/ns/dcat#> .
@prefix dct: <http://purl.org/dc/terms/> .
@prefix prov: <http://www.w3.org/ns/prov#> .
@prefix vcard: <http://www.w3.org/2006/vcard/ns#> .

<https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> rdf:type dcat:Dataset ;
  # ...
  .

<https://data.digdir.no/datasets/ai_projects_norwegian_state_api> rdf:type dcat:DataService ;
  dcat:servesDataset <https://data.digdir.no/datasets/ai_projects_norwegian_state_dataset> ;
  dcat:endpointURL <https://data.digdir.no/api/ai_projects_norwegian_state> ; # fiktiv URL, fungerer ikke
  dct:title "API for oversikt over KI-prosjekter i offentlig sektor"@nb ;
  dct:publisher <https://organization-catalogue.fellesdatakatalog.digdir.no/organizations/991825827> ;
  dcat:contactPoint [
    rdf:type vcard:Organization ;
    vcard:hasEmail "kunstigintelligens@digdir.no" ;
    vcard:fn "Kunstig Intelligens Digdir" ;
  ] ;
  dct:license <http://publications.europa.eu/resource/authority/licence/CC0> ;
  dct:format <http://publications.europa.eu/resource/authority/file-type/XML> ,
             <http://publications.europa.eu/resource/authority/file-type/JSON> ;
  .