Smartdatanet Metadata API

Italiano English

Esposizione API di ricerca e dettaglio dei Metadati di stream e dataset Contenuti nella Smartdata Platform

URL Base ricerca in formato JSON
https://api.smartdatanet.it/metadataapi/api/v02/search?
URL Base ricerca in formato CKAN
https://api.smartdatanet.it/metadataapi/api/ckan/2/package_list?
URL Base per generazione di Data Catalog Interoperability Protocol (DCAT-AP-IT) in formato JSON+LD
https://api.smartdatanet.it/metadataapi/api/dcat/dataset_list?
V01 (deprecated) URL Base ricerca in formato JSON Swagger Doc
https://api.smartdatanet.it/metadataapi/api/search/full?
Parametri
KeyDescValori previsti
qquery di ricercaTesto libero
langLingua in cui si desidera avere l'ambito del e i tag associati al dataset/streamGestiti italiano (lang=it) e inglese (lang=en)
Filtri
tenantCodice del tenant proprietario dello stream/datasetSe indicato un codice tenant non censito restituisce zero valori
organizationCodice dell'organizzazione proprietaria dello stream/datasetSe indicato un codice organizzazione non censita restituisce zero valori
domainCodice dell'ambito dello stream/datasetSe indicato un codice ambito non censito restituisce zero valori
opendataProprietà del dato/stream di essere opendataSe indicato opendata=true filtra estraendo i dati opendata, se indicato con valore diverso da true estrae solo i dati NON opendata. Se omesso non filtra sulla proprietà opendata
tagsElenco dei tag associati al dataset/streamInserire i tagCode separati da virgola
visibilityFiltro sul tipo di visibilitàUtilizzare i valori public o private. Non indicare il parametro per averli tutti
isSearchExactSe valorizzato a true effettua la ricerca per parola esatta (invece che lemmattizzata)Campo booleano (true/false). Se omesso vale false.
includeSandboxIndica che è necessario includere i dati di sandbox (di default non sono presenti)Campo booleano (true/false). Se omesso vale false.
hasStreamSe a true include solo i dataset/stream che hanno una componente stream (i formati CKAN e DCAT non consentono l'utilizzo di questo parametro) Campo booleano (true/false). Non indicare il parametro per averli tutti
hasDatasetSe a true include solo i dataset/stream che hanno una componente dataset (i formati CKAN e DCAT non consentono l'utilizzo di questo parametro)Campo booleano (true/false). Non indicare il parametro per averli tutti
externalReferenceFiltra per il campo externalReference (wildcards consentite)Campo stringa
Paginazione
startPaginazione: prima riga da estrarreCampo numerico intero (se omesso si parte da zero)
rowsPaginazione: numero di righe da estrarreCampo numerico intero (se omesso vengono estratte 12 righe). Valore massimo: 1000
Ricerca Geolocalizzata
minLatMinima latitudine del rettangolo contenente gli smartobjectCampo numerico min=-90.0 max=90.0
minLonMinima longitudine del rettangolo contenente gli smartobjectCampo numerico min=-180.0 max=180.0
maxLatMassima latitudine del rettangolo contenente gli smartobjectCampo numerico min=-90.0 max=90.0
maxLonMassima longitudine del rettangolo contenente gli smartobjectCampo numerico min=-180.0 max=180.0
Facet Documentazione su Apache Solr
facet.fieldLista di campi separati da virgola su cui calcolare le facetEs. tenatCode,domainCode
facet.prefixLimita i termini utilizzati per le facet a quelli che iniziano con il prefisso specificatoTesto libero
facet.sortCampo secondo cui ordinare il risultatocount valori più per primi - index in ordine di icdice
facet.containsLimita i termini utilizzati per le facet a quelli che contengono il testo indicatoTesto libero
facet.contains.ignoreCaseSe utilizzato facet.contains effettua il controllo indipendentemente da maiuscole/minuscoleTesto libero
facet.limitNumero di elmenti massimi da resituire per ogni facetcampo numerico
facet.offsetOffest da cui iniziare a restituire le facetcampo numerico
facet.mincountMinimo valore di conteggio che ogni facet deve avere per essere inclusa nella rispostacampo numerico
facet.missingVengono conteggiati solo le facet per i campi che non hanno il valore specificatoTesto libero

Dettaglio

URL Base dettaglio stream in formato JSON
https://api.smartdatanet.it/metadataapi/api/v02/detail/{{tenantCode}}/{{smartobjectCode}}/{{streamCode}}?
dove:
  • {{tenantCode}} è il codice dell'organizzazione proprietaria dello stream
  • {{smartobjectCode}} è il codice dello Smart Object utilizzato dallo stream
  • {{streamCode}} è il codice dello stream
URL Base dettaglio dataset in formato JSON
https://api.smartdatanet.it/metadataapi/api/v02/detail/{{tenantCode}}/{{datasetCode}}
dove:
  • {{tenantCode}} è il codice dell'organizzazione proprietaria dello stream
  • {{datasetCode}} è il codice del dataset
URL Base dettaglio in formato CKAN
https://api.smartdatanet.it/metadataapi/api/ckan/2/package_list/{{packageId}}
dove:
  • {{packageId}} è il packageId preso dalla lista restituita dalla ricerca (sempre in formato ckan)
V01 (deprecated) URL Base dettaglio stream in formato JSON Swagger Doc
https://api.smartdatanet.it/metadataapi/api/detail/{{tenantCode}}/{{smartobjectCode}}/{{streamCode}}?
V01 (deprecated) URL Base dettaglio dataset in formato JSON Swagger Doc
https://api.smartdatanet.it/metadataapi/api/v02/detail/{{tenantCode}}/{{datasetCode}}
Parametri
KeyDescValori previsti
langLingua in cui si desidera avere l'ambito del e i tag associati al dataset/streamGestiti italiano (lang=it) e inglese (lang=en)

Autenticazione per stream/dataset privati

Per consultare i metadati degli stream/dataset privati è necessario utilizzare il token oAuth durante la chiamata inserendo nell'header HTTP l'attributo
'Authorization'  'Bearer IlMioTokenOauth'
E' sufficiente utilizzare un qualunque token recuperato da Userportal per poter trovare anche gli stream/dataset privati a cui l'utente associato al token è abilitato.
I token sono disponibili nella sezione Sottoscrizioni dello Userportal (visibile solo dopo l'autenticazione)
Ulterioni dettagli sul Developer Center nella sezione Come accedere ai servizi di lettura autenticandosi con Oauth