Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PUBBLICAZIONE DEPRECATA. PER VISUALIZZARE LA DOCUMENTAZIONE AGGIORNATA ANDARE SU SITO_IRIS/sr/doc/rest/gw-rest-api.jsp ad es. https://air.unimi.it/sr/doc/rest/gw-rest-api.jsp

Table of Contents

Introduzione

Questo è il documento di riferimento per le Application Programming Interface (API) del servizio IRIS GateWay REST.

Queste API sono progettate per essere utilizzate dagli sviluppatori per recuperare le informazioni IRIS e utilizzarle in altre applicazioni.

Al momento queste API coprono estesamente le risorse dai moduli IRIS RM e IRIS AP.

C'è un'ulteriore API per il recupero delle pubblicazioni (IRIS IR). Si tratta di un'API temporanea sviluppata in attesa della prossima versione di IRIS IR che avrà DSpace6 come core e che è previsto per il 2020.

Le API GW REST sono accessibili tramite un browser Web, ma si consiglia l'uso di un client specifico o di plug-in del browser (ci sono diversi plugin per Mozilla Firefox, Google Chrome, ...)

Autenticazione e autorizzazione

Per accedere all'API GEST REST deve essere utilizzata l'autenticazione di base HTTP su https.
È necessario disporre di un account specifico che può essere fornito dallo staff di IRIS, su richiesta.

Convenzioni sugli URI REST

Le API GW REST forniscono accesso alle risorse (entità dati) tramite i percorsi URI in base alle convenzioni REST e agli standard RFC HTTP.

Tutte le risposte sono in formato JSON (JavaScript Object Notation. È un formato leggero per lo scambio di dati, facile da leggere e scrivere per gli esseri umani e facile da generare e analizzare da parte delle macchine. Si basa su un sottoinsieme del linguaggio di programmazione JavaScript, ma è un formato di testo completamente indipendente dal linguaggio. Usa convenzioni già familiari ai programmatori dei linguaggi derivati dal C.)

Sintassi di JSON

JSON prende origine dalla sintassi degli oggetti letterali in JavaScript. Un oggetto letterale può essere definito così:

var JSON = {
  proprieta1: 'Valore',
  proprieta2: 'Valore',
  proprietaN: 'Valore'
}

Il contenuto trasportato dall'oggetto JSON è il PAYLOAD.


Dalla versione v1 sono permesse solo richieste GET.

Gli URI dell'API REST di GW seguono questo schema:

http://<iris-host>/gw/rest/api/<resource-collection-name>[;full][/<resource-identifier>]

Tutti i nomi delle risorse disponibili resource-collection-name sono dettagliati nelle seguenti sezioni.

Per ottenere l'elenco di tutte le risorse in una raccolta, l'URL costruito deve seguire questo modello:

http://<iris-host>/gw/rest/api/<resource-collection-name>

Per ottenere una risorsa single resource l'URL costruito deve seguire questo modello

http://<iris-host>/gw/rest/api/<resource-collection-name>/<resource-identifier>


Ad esempio, per recuperare un dipartimento specifico (dipartimento identificato da 328235 per esempio), si dovrebbe accedere a: https://<iris-host>/gw/rest/api/departments/328235

Quasi tutte le raccolte di risorse disponibili sono fornite in due varianti:

  • base (predefinito)
    1. Viene restituito solo un piccolo sottoinsieme di dati.
    2. I risultati sono divisi in pagine e ogni pagina mostra 20 risultati.
    3. Il numero di elementi per pagina può essere personalizzato fino a 500, ma non è consigliabile per evitare problemi di prestazioni.
    4. Per modificare la divisione delle pagine, deve essere utilizzato il parametro pageSize. 
    5. è il formato che DEVE essere utilizzato per la ricerca.
  • completo (identificato dal parametro ;full)
    1. Tutti i metadati vengono restituiti.
    2. DEVE essere utilizzato per recuperare informazioni dettagliate per un articolo specifico.
    3. Questa versione NON fornisce tutte le funzionalità di filtraggio fornite dalla controparte di base.
    4. Se questa versione viene utilizzata per effettuare una ricerca, la dimensione della pagina è limitata a un articolo per pagina per evitare problemi di prestazioni, poiché il singolo elemento può contenere molte informazioni.
    5. Nel prossimo futuro saranno presumibilmente realizzati dei miglioramenti per consentire l'aumento del numero di articoli per pagina in questa versione completa, al fine di ottimizzare l'accesso batch.


Secondo le convenzioni REST:
• viene restituito un array JSON ([]) che richiama un URL che fa riferimento a tutte le risorse in una raccolta
• viene restituito un oggetto JSON ({}) che richiama un URL che fa riferimento a una singola risorsa.

Parametri di filtro per le richieste REST

Le richieste GW REST possono specificare vari parametri di filtro che variano da raccolta a raccolta.
I parametri di query standard sono consentiti per le richieste di raccolte o di singole risorse.
Per esempio:
• https://<iris-host>/gw/rest/api/public-engagements?validation.relation=mostValidated
https://<iris-host>/gw/rest/api/public-engagements/12345?validation.relation=mostValidated


Tutti i parametri di filtro disponibili per ogni tipo di risorsa sono elencati nella sezione specifica per ogni raccolta.

Le convenzioni REST non specificano come costruire un URL per ottenere una risorsa specifica quando questa risorsa ha più identificatori.

Per soddisfare questo requisito, le API GW REST consentono di specificare quale identificatore si desidera utilizzare quando si effettua una richiesta.

Ad esempio per ottenere una singola persona è possibile utilizzare uno dei seguenti URL:
https://<iris-host>/gw/rest/api/people/12345
https://<iris-host>/gw/rest/api/people/id=12345 (stesso risultato di quello precedente)
https://<iris-host>/gw/rest/api/people/pid=rp12345
https://<iris-host>/gw/rest/api/people/idAb=67890
https://<iris-host>/gw/rest/api/people/cf=XXXXXX00X00X000X
https://<iris-host>/gw/rest/api/people/sourceId=xxxx
https://<iris-host>/gw/rest/api/people/orcid=yyyyyy

Ciascuna delle precedenti richieste restituisce un singolo oggetto JSON {}.

Lo stesso risultato può essere ottenuto facendo queste richieste:
https://<iris-host>/gw/rest/api/people?id=12345
https://<iris-host>/gw/rest/api/people?pid=rp12345
https://<iris-host>/gw/rest/api/people?idAb=67890
https://<iris-host>/gw/rest/api/people?cf=XXXXXX00X00X000X
https://<iris-host>/gw/rest/api/people?sourceId=xxxx
https://<iris-host>/gw/rest/api/people?orcid=yyyyyy

Ciascuna delle precedenti richieste restituisce un array JSON contenente l'oggetto corrispondente [{}].

Tutti gli identificatori disponibili per ogni tipo di risorsa sono elencati nella sezione specifica per ogni raccolta.

Se non viene fornito alcun tipo di identificatore, l'uso dell'identificatore "id" è implicito.

Convenzioni sulle risposte REST

Ogni volta che viene effettuata una richiesta, il payload della risposta conterrà solo le informazioni relative alla risorsa.

Altre informazioni quali errori, impaginazione, ordinamento sono disponibili nelle intestazioni HTTP.

Queste intestazioni sono:

  • Item-Count
    numero di oggetti trovati
  • Item-Per-Page
    numero di elementi per pagina
  • Page
    numero della pagina corrente
  • Page-Count
    numero di pagine disponibili
  • Rest-Version
    versione del rest service
  • Sort
    lista dei campi di ordinamento in formato csv 
  • Dir
    direzione di ordinamento (asc|desc)

Risultati di ricerca e ordinamento REST

Per la navigazione e l'ordinamento dei risultati, è possibile utilizzare questi parametri di richiesta della query:

  • page
    numero di pagina da recuperare
  • sort
    campo di ordinamento
  • dir
    direzione dell'ordinamento (asc, desc)

Per esempio:
https://<iris-host>/gw/rest/api/people?page=2
https://<iris-host>/gw/rest/api/people?name=xxx&sort=name,id

I campi utilizzabili per l'ordinamento sono:

  • id
  • pid
  • year
  • name
  • startDate
  • lastModified
  • wfItemType.identifier (solo per oggetti con flusso di validazione)
  • wfItemType.description (solo per oggetti con flusso di validazione)

Gestione degli errori REST

Ogni volta che viene effettuata una richiesta, può essere restituito uno dei seguenti HTTP Response Header:

  • 200: OK
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not Found
  • 500: Internal Server Error

Se è capitato un errore interno (Internal Server Error), è possibile usare queste intestazioni per approfondire il problema:

  • error-code
    codice di errore
  • error-message
    messaggio dei dettagli dell'errore.

Nei rilasci futuri, queste intestazioni saranno rinominate diventando rispettivamente Error-Code e Error-Message.

Controllo di versione delle risorse REST

In IRIS ci sono alcune risorse abilitate per effettuare il versioning (versionamento).

Si consideri questo caso d'uso che chiarisce lo scenario.

Un ricercatore crea un oggetto (gruppo di lavoro, laboratorio, terza missione, ...) e aggiunge alcune informazioni: questo elemento è noto come master item.

Ad un certo punto, si decide di contrassegnare questo elemento come "approvato": questo è il momento in cui viene generata una "istantanea" (snapshot) per congelare le informazioni.

Quindi ora abbiamo due versioni dello stesso articolo: l'oggetto master (approvato) e quello snapshot (approvato).

Ammettiamo che alcuni giorni dopo l'utente scopra un errore ortografico e riapra quell'oggetto (o, più precisamente, riapra l'oggetto principale, perché invece l'istantanea è congelata).

Abbiamo ancora due versioni dello stesso oggetto: la master riaperta e la snapshot approvata.

Ora si decide di contrassegnare nuovamente questo elemento come "approvato": in questo preciso momento viene creata una nuova snapshot.

Ora abbiamo tre versioni dello stesso item: master (approvato) e due immagini snapshot (approvato).

Ogni ciclo di riapertura / approvazione genera una nuova istantanea.

I servizi REST espongono solo l'elemento principale e l'ultima istantanea, se disponibile.

Per semplificare la ricerca vengono introdotti due nuovi concetti:

most updated item → articolo più aggiornato: questo è sempre l'oggetto master

most validated item → articolo più validato: questo può essere il master item o l'ultima snapshot. Se l'elemento si trova in uno stato precedente allo stato di approvazione (o non è abilitato il controllo di versione), allora è disponibile solo l'elemento principale master. Per convenzione, esso sarà il most validated item, anche se non è mai stato approvato.

D'altra parte, se l'elemento si trova in uno stato dopo lo stato di approvazione, sono disponibili sia gli elementi master che gli snapshot. In questo caso l'elemento snapshot è quello "più validato".


Non tutte le risorse sono soggette al controllo di versione, ma quando lo sono è possibile utilizzare questo parametro di filtro aggiuntivo:

validation.relation 

Gli unici valori consentiti sono:

  • master
  • mostValidated
  • all

Se il parametro validation.relation non viene fornito, allora si assume che esso coincida col most validated.

NB: Si ricordi che gli ID vengono generati per ogni snapshot e master.

Gli oggetti visibili in IRIS RM o IRIS AP sono identificati dall'id master.

Gli ID delle snapshot sono disponibili nella scheda "Versioni".

Controllo di versione degli Endpoint REST

Ogni endpoint di raccolta può essere versionato.
La versione corrente è v1.
Se non diversamente specificato, si assume che sia la versione v1.
Per utilizzare una versione specifica, è possibile specificare un numero di versione tramite uno dei seguenti:

  • rest-version query parameter
  • Rest-Version header.

Dettagli del servizio REST

In questa sezione sono elencate tutte le raccolte di risorse disponibili.

Per ogni collezione sono specificate le seguenti informazioni:

  • Resource: nome della risorsa
  • Source: modulo sorgente IRIS (RM, AP, IR)
  • Endpoint: URL della collezione
  • Base: contrassegno che indica la disponibilità del servizio "base"
  • Full: contrassegno che indica la disponibilità del servizio "completo"
  • Versioned: flag che indica la disponibilità del controllo di versione della risorsa
  • Description: descrizione della risorsa.


ResourceSourceEndpointMethodBaseFullVersDescription
Projects (Progetti di ricerca)APhttps://<iris-host>/gw/rest/api/projectsGETXX
Questa collezione contiene tutti i projects (Progetti di ricerca) estratti da IRIS AP
Calls (Bandi di finanziamento)APhttps://<iris-host>/gw/rest/api/callsGETXX
Questa collezione contiene tutti i calls for proposal (Bandi di finanziamento) estratti da IRIS AP
Contracts (Contratti e convenzioni)APhttps://<iris-host>/gw/rest/api/callsGETXX
Questa collezione contiene tutti i contracts and conventions (Contratti) estratti da IRIS AP
Equipments (Grandi attrezzature)RMhttps://<iris-host>/gw/rest/api/equipmentsGETXXXQuesta collezione contiene tutti gli equipments (Grandi Attrezzature) estratti da IRIS RM
Incoming people (Mobilità in ingresso)RMhttps://<iris-host>/gw/rest/api/incoming-peopleGETXX
Questa collezione contiene tutti gli incoming people (Mobilità in ingresso) estratti da IRIS RM
Laboratories (Laboratori)RMhttps://<iris-host>/gw/rest/api/laboratoriesGETXXXQuesta collezione contiene tutti i laboratories (Laboratori) estratti da IRIS RM
Libraries (Biblioteche)RMhttps://<iris-host>/gw/rest/api/librariesGETXX
Questa collezione contiene tutte le libraries (Biblioteche) estratte da IRIS RM
People (Persone)RMhttps://<iris-host>/gw/rest/api/peopleGETXX
Questa collezione contiene people (Personale di Ateneo) estratti da IRIS RM
Prizes (Premi della ricerca)RMhttps://<iris-host>/gw/rest/api/prizesGETXX
Questa collezione contiene tutti i prizes (Premi della ricerca) estratti da IRIS RM
Public Engagements (Iniziative di Public engagements - Terza Missione)RMhttps://<iris-host>/gw/rest/api/public-engagementsGETXXXQuesta collezione contiene tutti i public engagements initiatives (Iniziative di public engagements - Terza Missione) estratti da IRIS RM
Research Centres (Centri di ricerca)RMhttps://<iris-host>/gw/rest/api/research-centresGETXXXQuesta collezione contiene tutti i centri research centres (Centri di ricerca) estratti da IRIS RM
Workgroups (Gruppi di ricerca)RMhttps://<iris-host>/gw/rest/api/workgroupsGETXXXQuesta collezione contiene tutti i workgroups (Gruppi di ricerca) estratti da IRIS RM
Academic Fields (SSD PRE riforma 2000)RMhttps://<iris-host>/gw/rest/api/academic-fieldsGETX

Questa collezione contiene tutti gli academic fields (SSD pre riforma 2000) estratti da IRIS RM
Academic Fields 2000 (SSD POST riforma 2000)RMhttps://<iris-host>/gw/rest/api/academic-fields-2000GETX

Questa collezione contiene tutti gli academic fields (SSD post riforma 2000) estratti da IRIS RM
Academic Areas (Macrosettori Concorsuali)RMhttps://<iris-host>/gw/rest/api/academic-areasGETX

Questa collezione contiene tutti gli academic groups (Macrosettori Concorsuali) estratti da IRIS RM
Academic Groups (Settori Concorsuali)RMhttps://<iris-host>/gw/rest/api/academic-groupsGETX

Questa collezione contiene tutti gli academic groups (Settori Concorsuali) estratti da IRIS RM
Departments (Dipartimenti)RMhttps://<iris-host>/gw/rest/api/departmentsGETX

Questa collezione contiene tutti i departments of the University (Dipartimenti) estratti da IRIS RM
External Organizations (Organizzazioni esterne)RMhttps://<iris-host>/gw/rest/api/external-organizationsGETX

Questa collezione contiene tutte le organizzazioni con cui l'Università ha una collaborazione (Organizzazioni esterne) estratti da IRIS RM
Faculties (Facoltà)RMhttps://<iris-host>/gw/rest/api/facultiesGETX

Questa collezione contiene tutte le faculties (Facoltà) estratte da IRIS RM
Journals (Riviste)RMhttps://<iris-host>/gw/rest/api/journalsGETX

Questa collezione contiene tutti i journals (Riviste) estratti da IRIS RM
Person roles (Ruoli delle persone)RMhttps://<iris-host>/gw/rest/api/person-rolesGETX

Questa collezione contiene tutti i person roles (Ruoli delle persone) estratti da IRIS RM
Person titles (Profili delle persone)RMhttps://<iris-host>/gw/rest/api/person-titlesGETX

Questa collezione contiene tutti i person titles (Profili delle persone) estratti da IRIS RM
Publications (Pubblicazioni) - NB: in dismissione per la fine del 2019RMhttps://<iris-host>/gw/rest/api/publications.tmpGETX

Questa collezione contiene tutte le pubblicazioni (Publications) estratte da IRIS IR.


Dividiamo i servizi in base al tipo di payload:

  1. payload complessi per i quali si rimanda alla documentazione di modello (cliccare su ogni elemento del seguente elenco):
    1. Progetti
    2. Bandi di finanziamento
    3. Contratti
    4. Grandi Attrezzature
    5. Mobilità in ingresso
    6. Laboratori
    7. Terza Missione (public engagements)
    8. Centri di ricerca (researchCentre)
    9. Gruppi di ricerca

  2. payload complessi non ricostruibili da documentazione di modello:
    1. Persone
    2. Premi
    3. Biblioteche
    4. Riviste
    5. Pubblicazioni

  3. payload semplici (assimilabili a dizionari) NON ricostruibili da documentazione di modello:
    1. SSD
    2. Macrosettori concorsuali
    3. Settori concorsuali
    4. Dipartimenti
    5. Organizzazioni esterne
    6. Facoltà
    7. Ruoli delle persone
    8. Profili delle persone

Progetti

METODO GET:

 /gw/rest/api/projects


Tutti i parametri segnati con asterisco "*" possono essere usati come identificatori per ottenere una singola risorsa.

Nella versione FULL, invece, sono utilizzabili solo i paramentri contrassegnati da asterisco. Gli altri vengono ignorati.

Tutti i parametri in parentesi quadre [...] accettano valori multipli. Ad esempio: 

https://<iris-host>/gw/rest/api/projects?type=2018&year=2019 

Campi disponibili per l'ordinamento: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Parametri della Query di richiesta:

parametrovaloredescrizione

*id

string

Stringa con l'identificativo ID dell'item

*pid

string

Stringa con l'identificatore persistente

[macrotype]

string

Stringa contenente il macro tipo dell'elemento. Per conoscere tutti i possibili valori, contattare l'helpdesk del gruppo di supporto IRIS

[type]

string

Stringa contenente il tipo dell'elemento. Per conoscere tutti i possibili valori, contattare l'helpdesk del gruppo di supporto IRIS

activeboolean

Questo parametro consente di filtrare gli oggetti basandosi sul loro stato: attivo o cessato.
Lo stato attivo o cessato viene inferito dal metadato endDate (come da documentazione di modello dell'entità di riferimento).
Gli unici valori consentiti sono true e false.
Se il parametro non viene fornito vengono ritornati tutti gli oggetti.

validation.relation

string

Valori permessi: master|mostValidated|all. Se non c'è, allora il valore default è mostValidated

visibleOnPortal

boolean

Questo parametro permette il filtraggio degli item basati sull'autorizzazione data dal creatore dell'elemento stesso.

I valori possibili sono TRUE e FALSE.

Se il valore di questo parametro non viene fornito, allora vengono restituiti tutti gli item.

[year]

number

Anno di creazione dell'item

[wfState]

string

Stringa contenente wfState (stato del workflow) dell'item.

name

string

Stringa contenente la descrizione dell'item. È possibile cercare col carattere "*".

person.id

string

Stringa contenente l'id IRIS della Persona

person.idAb

string

Stringa contenente l'idAb della Persona

person.cf

string

Stringa contenente il Codice Fiscale della Persona

person.sourceId

string

Stringa contenente l'identificativo sorgente della Persona, per coloro che non fanno uso di U-gov

person.pid

string

Stringa contenente il Person PID di IRIS modulo IR.

person.orcid

string

Stringa contenente il Person ORCID.

person.relation

owner|contributor

Questo campo permette di specificare la relazione della persona con l'elemento. I valori possibili sono solo owner o contributor.

Questo campo deve essere usato in associazione con un altro filtro persona come ad esempio person.cf.

Se non viene definito, si prende qualsiasi tipo di associazione.

department.id

string

Stringa contenente l'id del parametro

department.idAb

string

Stringa contenente l'idAb U-gov del dipartimento.

department.sourceId

string

Stringa contenente il sourceId di dipartimento (per enti che non usano U-GOV).

department.relation

owner|contributor

Questo parametro specifica il ruolo nel dipartimento: main(owner) oppure secondary (contributor)

I valori possibili sono solo owner o contributor.

Il campo va usato in associazioni con altri filtri di dipartimento come department.idAb.

Se viene specificato, allora vengono restituiti solo gli item che corrispondono allo specifico dipartimento e al ruolo indicato.

Se invece il parametro non è indicato, allora vengono restituiti tutti gli item che corrispondono al dipartimento specificato.

department.match

byPerson|byDepartment

Questo parametro permette di specificare la modalità di selezione del dipartimento: per persona oppure per dipartimento.

Infatti i valori possibili sono byPerson oppure byDepartment.

Il campo va usato in associazione con altri filtri di dipartimento come il department.idAb.

Se non viene fornito, allora si usano entrambi i tipi di associazione, altrimenti solo quella specificata.

L'associazione "byPerson" prende il dipartimento ATTUALE della persona (owner o contributor). L'associazione "byDepartment" risale al dipartimento che era valido nel momento della CREAZIONE dell'item.

ESEMPI:

Per recuperare tutti gli elementi:


					https://<iris-host>/gw/rest/api/projects
					

Per cercare la persona di codice fiscale=123456:

					https://<iris-host>/gw/rest/api/projects?person.cf=UYGUSGAUYGUGY					
					

Per cercare la persona che è "owner" del progetto e ha codice fiscale UYGUSGAUYGUGY:

					https://<iris-host>/gw/rest/api/projects?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					

Per cercare tutte le persone con idAb pari a 123456:

					https://<iris-host>/gw/rest/api/projects?person.idAb=123456&
					

Per cercare tutti i dipartimenti con idAb pari a 123456:

					https://<iris-host>/gw/rest/api/projects?department.idAb=123456
					

Per cercare un progetto il cui "owner" ha un id di dipartimento pari a 4400, corrente(per persona) o passato (per dipartimento):

					https://<iris-host>/gw/rest/api/projects?department.relation=owner&department.match=byPerson&department.id=4400
					

Grandi attrezzature (equipment)

METODO GET::

/gw/rest/api/equipments

Tutti i parametri segnati con asterisco "*" possono essere usati come identificatori per ottenere una singola risorsa (single resource).

Nella versione FULL, invece, sono utilizzabili solo i paramentri contrassegnati da asterisco: gli altri vengono silenziosamente ignorati.

Tutti i parametri in parentesi quadre [...] accettano valori multipli. Ad esempio: 

https://<iris-host>/gw/rest/api/projects?type=2018&year=2019 

Campi disponibili per l'ordinamento: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description


parametrovaloredescrizione

*id

string

Stringa contenente l'id dell'ITEM

*pid

string

Stringa contenente l'identificativo persistente

[type]

string

Stringa contenente il tipo di Item. Fare riferimento all'helpdesk di IRIS per conoscere i tipi disponibili.

activeboolean

Questo parametro consente di filtrare gli oggetti basandosi sul loro stato: attivo o cessato.
Lo stato attivo o cessato viene inferito dal metadato endDate (come da documentazione di modello dell'entità di riferimento).
Gli unici valori consentiti sono true e false.
Se il parametro non viene fornito vengono ritornati tutti gli oggetti.

validation.relation

string

Valori permessi: master|mostValidated|all. Se non c'è, allora il valore default è mostValidated

visibleOnPortal

boolean

Questo parametro permette il filtraggio degli item basati sull'autorizzazione data dal creatore dell'elemento stesso.

I valori possibili sono TRUE e FALSE.

Se il valore di questo parametro non viene fornito, allora vengono restituiti tutti gli item.

year

number

Anno di creazione dell'item

wfState

string

Stringa contenente wfState dell'item

name

string

Stringa contenente la descrizione dell'item. Si può anche usare il carattere asterisco "*".

person.id

string

Stringa contenente l'IRIS person id

person.idAb

string

Stringa contenente il Person idAb

person.cf

string

Stringa contenente il Codice Fiscale

person.sourceId

string

Stringa contenente la persona, per gli Enti che non fanno uso di U-GOV

person.pid

string

Stringa contenente il Person PID (IRIS IR)

person.orcid

string

Stringa contenente il Person ORCID

person.relation

owner|contributor

Questo campo definisce una specifica relazione per una persona, e viene inteso in associazione con un altro filtro persona come ad esempio person.cf.

Se non viene definito, si prende qualsisi tipo di associazione.

department.id

string

Stringa contenente l'id Dipartimento.

department.idAb

string

Stringa contenente l'idAb Dipartimento (U-GOV).

department.sourceId

string

Stringa contenente il Dipartimento (per coloro che non hanno U-GOV).

department.relation

owner|contributor

Questo parametro permette di specificare il ruolo dipartimento: principale o secondario. I valori possibili sono solamente owner o contributor.

Questo campo va usato in associazione con altri filtri di dipartimento come ad esempio department.idAb. Se viene specificato, allora vengono restituiti solo gli item che corrispondono allo specifico dipartimento e al ruolo indicato.

Se invece il parametro non è indicato, allora vengono restituiti tutti gli item che corrispondono al dipartimento specificato.

userTypestring

Questo parametro permette di specificare la tipologia di Utenza da cercare.

Se specificato, vengono restituiti gli item che hanno al loro interno quella specifica Utenza con il codice specifco.

E' possibile specificare più di un valore, nel qual caso verranno recuperati gli item che hanno al loro interno almeno una Utenza di quel tipo.

Per vedere i codici collegati ai dizionari, cercare nel menù di gestione dizionari la voce "RM - ATTREZZATURE - UTENZA" ( all'URL https://<iris-host>/ma/dictionary/list.htm )

Vedi esempi    

department.match

byPerson|byDepartment

Questo parametro permette di specificare la modalità di selezione del dipartimento: per persona oppure per dipartimento. Infatti i valori possibili sono byPerson oppure byDepartment.

Il campo va usato in associazione con altri filtri di dipartimento come il department.idAb.

Se non viene fornito, allora si usano entrambi i tipi di associazione, altrimenti solo quella specificata.

L'associazione "byPerson" prende il dipartimento ATTUALE della persona (owner o contributor). L'associazione "byDepartment" risale al dipartimento che era valido nel momento della CREAZIONE dell'item.

Esempi:

Per cercare tutti gli elementi:


	https://<iris-host>/gw/rest/api/equipments
					

Per cercare gli elementi con una persona con CF uguale a UYGUSGAUYGUGY


	https://<iris-host>/gw/rest/api/equipments?person.cf=UYGUSGAUYGUGY					
					

Per cercare gli elementi con una persona con ruolo di Responsabile e con un CF uguale a UYGUSGAUYGUGY


	https://<iris-host>/gw/rest/api/equipments?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					

Per cercare gli elementi con una persona con un identificatico MIUR (idAb) uguale a 123456


	https://<iris-host>/gw/rest/api/equipments?person.idAb=123456&
					

Per cercare gli elementi con un dipartimento con un identificatico MIUR (idAb) uguale a 123456:


	https://<iris-host>/gw/rest/api/equipments?department.idAb=123456
					

Per cercare una Grande Attrezzatura il cui proprietario ha un attuale (by person) o precedente (byDepartment) dipartimento il cui identificativo è 4400:


	https://<iris-host>/gw/rest/api/equipments?department.relation=owner&department.match=byPerson&department.id=4400
					

Per cercare le Grandi Attrezzature che hanno al loro interno una Utenza con codice userType.internal


	https://<iris-host>/gw/rest/api/equipments?userType=userType.internal
					

To search an Equipment that contains at least one user type dictionary with codes userType.byProject or userType.internal


	https://<iris-host>/gw/rest/api/equipments?userType=userType.byProject&userType=userType.internal
					

available response representations:
FULL OUTPUT: https://<iris-host>/gw/rest/api/equipments;full/id=12345

Code Block
themeEclipse
titleGrande Attrezzatura: Risposta FULL
linenumberstrue
collapsetrue
{
        "uid": "wfItem-17032",
        "id": 17032,
        "discriminator": "wfItem",
        "displayValue": "TEST FAST",
        "year": 2001,
        "snapshot": false,
        "lastModified": "2018-04-10T12:14:40",
        "laboratoryEquipmentLinkSet": [
            {
                "child": {
                    "id": 17032,
                    "description": "TEST FAST"
                },
                "parent": {
                    "id": 16775,
                    "description": "LabCozzi 55"
                }
            }
        ],
        "internalRepresentativeSet": [
            {
                "person": {
                    "id": 12704,
                    "cf": "RSSDXXXXXXXXXXX",
                    "firstName": "ADRIANA",
                    "idAb": "144856",
                    "pid": "rp09904",
                    "lastName": "ROSSI"
                }
            }
        ],
        "ownerSet": [
            {
                "person": {
                    "idAb": "168354",
                    "id": 19618,
                    "firstName": "DANIELA",
                    "cf": "RSSXXXXXXXXXXX",
                    "pid": "rp14603",
                    "lastName": "ROSSI"
                }
            }
        ],
        "wfItemType": {
            "parentWfItemTypeSet": {
                "identifier": "EQP",
                "description": "Grandi attrezzature"
            },
            "identifier": "EQP.RIC",
            "code": "EQP",
            "description": "Grande attrezzatura di ricerca"
        },
        "internalOrganizationUnitSet": [
            {
                "organizationUnit": {
                    "id": 1863,
                    "sourceId": "1176",
                    "idAb": "112097",
                    "description": "EX-DIPARTIMENTO DI MEDICINA CLINICA, PREVENZIONE E BIOTECNOLOGIE SANITARIE-(1998/2006)"
                }
            },
            {
                "organizationUnit": {
                    "id": 1860,
                    "sourceId": "1175",
                    "idAb": "112096",
                    "description": "EX-DIPARTIMENTO DI MEDICINA SPERIMENTALE, AMBIENTALE E BIOTECNOLOGIE MEDICHE-(1998/2006)"
                }
            }
        ],
        "identifier": "EQP-0016",
        "wfState": {
            "id": 650,
            "description": "submitted"
        },
        "inUse": true,
        "userTypeSet": [
            {
                "user": {
                    "id": 87565,
                    "description": "Esterna all'ateneo"
                }
            },
            {
                "user": {
                    "id": 87564,
                    "description": "Interna all'ateneo"
                }
            }
        ],
        "note": "note tante note",
        "serialNumber": "234",
        "activationYear": 2002,
        "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
            {
                "organizationUnit": {
                    "id": 30955,
                    "description": "DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
                }
            }
        ],
        "description": "TEST FAST",
        "costTypeSet": [
            {
                "cost": {
                    "id": 87568,
                    "description": "Interni"
                }
            }
        ],
        "equipment": {
            "id": 442,
            "description": "TEST FAST"
        },
        "applicationsSet": [
            {
                "application": {
                    "description": "Contratti di ricerca",
                    "id": 87567
                }
            },
            {
                "application": {
                    "description": "Progetti di ricerca",
                    "id": 87566
                }
            }
        ],
        "manifacturingYear": 2000,
        "startDate": "2018-04-01T00:00:00",
        "inventoryCode": "123",
        "visibleOnPortal": true,
        "abstract": "A longer description",
        "esfriClassificationSet": [
            {
                "classification": {
                    "description": "Health and Food Domain",
                    "id": 88117
                }
            }
        ],
        "historicalEvidence": true
    }



BASE OUTPUT: https://<iris-host>/gw/rest/api/equipments?id=12345

Code Block
themeEclipse
titleGrande Attrezzatura: Risposta BASE
linenumberstrue
collapsetrue
{
        "id": 17032,
        "displayValue": "TEST FAST",
        "year": 2001,
        "ownerSet": [
            {
                "person": {
                    "firstName": "DANIELE",
                    "idAb": "168354",
                    "id": 19618,
                    "pid": "rp14603",
                    "cf": "RSSDNL81B24E507H",
                    "lastName": "ROSSI"
                }
            }
        ],
        "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
            {
                "organizationUnit": {
                    "id": 30955,
                    "description": "DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
                }
            }
        ],
        "wfState": {
            "id": 650,
            "description": "submitted"
        }
    }
]


Terza missione

METODO GET:

/gw/rest/api/public-engagements

Tutti i parametri segnati con asterisco "*" possono essere usati come identificatori per ottenere una singola risorsa (single resource)

Nella versione FULL, invece, sono utilizzabili solo i paramentri contrassegnati da asterisco: gli altri vengono silenziosamente ignorati.

Campi disponibili per l'ordinamento: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Parametri della Query di richiesta:

parametrovaloredescrizione

*id

string

Stringa contenente l'id dell'ITEM

*pid

string

Stringa contenente l'identificativo persistente

[type]

string

Stringa contenente il tipo di Item. Fare riferimento all'helpdesk di IRIS per conoscere i tipi disponibili.

activeboolean

Questo parametro consente di filtrare gli oggetti basandosi sul loro stato: attivo o cessato.
Lo stato attivo o cessato viene inferito dal metadato endDate (come da documentazione di modello dell'entità di riferimento).
Gli unici valori consentiti sono true e false.
Se il parametro non viene fornito vengono ritornati tutti gli oggetti.

validation.relation

string

Valori permessi: master|mostValidated|all. Se non c'è, allora il valore default è mostValidated

visibleOnPortal

boolean

Questo parametro permette il filtraggio degli item basati sull'autorizzazione data dal creatore dell'elemento stesso.

I valori possibili sono TRUE e FALSE.

Se il valore di questo parametro non viene fornito, allora vengono restituiti tutti gli item.

year

number

Anno di creazione dell'item

wfState

string

Stringa contenente wfState dell'item

name

string

Stringa contenente la descrizione dell'item. Si può anche usare il carattere asterisco "*".

person.id

string

Stringa contenente l'IRIS person id

person.idAb

string

Stringa contenente il Person idAb

person.cf

string

Stringa contenente il Codice Fiscale

person.sourceId

string

Stringa contenente la persona, per gli Enti che non fanno uso di U-GOV

person.pid

string

Stringa contenente il Person PID (IRIS IR)

person.orcid

string

Stringa contenente il Person ORCID

person.relation

owner|contributor

Questo campo definisce una specifica relazione per una persona, e viene inteso in associazione con un altro filtro persona come ad esempio person.cf.

Se non viene definito, si prende qualsisi tipo di associazione.

department.id

string

Stringa contenente l'id Dipartimento.

department.idAb

string

Stringa contenente l'idAb Dipartimento (U-GOV).

department.sourceId

string

Stringa contenente il Dipartimento (per coloro che non hanno U-GOV).

department.relation

owner|contributor

Questo parametro permette di specificare il ruolo dipartimento: principale o secondario. I valori possibili sono solamente owner o contributor.

Questo campo va usato in associazione con altri filtri di dipartimento come ad esempio department.idAb. Se viene specificato, allora vengono restituiti solo gli item che corrispondono allo specifico dipartimento e al ruolo indicato.

Se invece il parametro non è indicato, allora vengono restituiti tutti gli item che corrispondono al dipartimento specificato.

department.match

byPerson|byDepartment

Questo parametro permette di specificare la modalità di selezione del dipartimento: per persona oppure per dipartimento. Infatti i valori possibili sono byPerson oppure byDepartment.

Il campo va usato in associazione con altri filtri di dipartimento come il department.idAb.

Se non viene fornito, allora si usano entrambi i tipi di associazione, altrimenti solo quella specificata.

L'associazione "byPerson" prende il dipartimento ATTUALE della persona (owner o contributor). L'associazione "byDepartment" risale al dipartimento che era valido nel momento della CREAZIONE dell'item.


Esempi

Per cercare tutti gli elementi:

https://<iris-host>/gw/rest/api/public-engagements

Per cercare un Item con id=123456:
https://<iris-host>/gw/rest/api/public-engagements?id=123456
					

Per cercare un Item con miurIdentifier=123456:

https://<iris-host>/gw/rest/api/public-engagements?miurIdentifier=123456
					

Per cercare un Item il cui nome è Scienze:

https://<iris-host>/gw/rest/api/public-engagements?name=Scienze
					

Per cercare una TerzaMissione il cui proprietario ha un attuale (by person) o precedente (byDepartment) dipartimento il cui identificativo è 4400:

https://<iris-host>/gw/rest/api/public-engagements?department.relation=owner&department.match=byPerson&department.id=4400

Sono disponibili le seguenti risposte:				

BASE OUTPUT: https://<iris-host>/gw/rest/api/public-engagements/id=12345

Code Block
themeEclipse
titleTerza Missione: Risposta BASE
linenumberstrue
collapsetrue
{
    "id": 17031,
    "displayValue": "test terza missione",
    "year": 2018,
    "ownerSet": [
        {
            "person": {
                "idAb": "105031",
                "id": 505,
                "pid": "rp00180",
                "firstName": "NOME",
                "cf": "WSDWSD",
                "ORCID": "0000-0002-1195-530X",
                "lastName": "COGNOME"
            },
            "secondaryRoleSet": [
                {
                    "role": {
                        "id": 20928,
                        "code": "ownerRolePublicEngagement.manager",
                        "description": "Responsabile scientifico"
                    }
                }
            ],
            "role": {
                "id": 87467,
                "description": "Organizzatore"
            }
        }
    ],
    "mainInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "description": "DIPARTIMENTO DI INFORMATICA, SISTEMISTICA E COMUNICAZIONE",
                "id": 4401
            }
        }
    ],
    "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "id": 4401,
                "description": "DIPARTIMENTO DI INFORMATICA, SISTEMISTICA E COMUNICAZIONE"
            }
        }
    ],
    "wfState": {
        "id": 664,
        "description": "draft"
    }
}


FULL OUTPUT: https://<iris-host>/gw/rest/api/public-engagements;full/id=12345

Code Block
themeEclipse
titleTerza Missione: Risposta FULL
linenumberstrue
collapsetrue
{
    "uid": "wfItem-17031",
    "id": 17031,
    "discriminator": "wfItem",
    "displayValue": "test terza missione",
    "year": 2018,
    "snapshot": false,
    "lastModified": "2018-04-11T17:39:16",
    "estimatedImpact": "asdasdsadsad",
    "contributorSet": [
        {
            "person": {
                "pid": "rp05200",
                "id": 5526,
                "lastName": "COGNOME",
                "idAb": "127652",
                "cf": "XXXYYY",
                "firstName": "NOME"
            },
            "role": {
                "description": "Discussant",
                "id": 87546
            }
        }
    ],
    "ownerSet": [
        {
            "person": {
                "idAb": "105031",
                "id": 505,
                "firstName": "SECONDO NOME",
                "cf": "RCLFNC61M60G535N",
                "pid": "rp00180",
                "ORCID": "0000-0002-1195-530X",
                "lastName": "COGNOME COGNOME"
            },
            "secondaryRoleSet": [
                {
                    "role": {
                        "id": 20928,
                        "code": "ownerRolePublicEngagement.manager",
                        "description": "Responsabile scientifico"
                    }
                }
            ],
            "role": {
                "description": "Organizzatore",
                "id": 87467
            }
        }
    ],
    "publicEngagementProjectLinkSet": [
        {
            "parent": {
                "description": "test terza missione arcelli nuova",
                "id": 17031
            },
            "child": {
                "description": "Mucosal Immunization-Cluster Project",
                "id": 2349
            }
        }
    ],
    "wfItemType": {
        "parentWfItemTypeSet": {
            "identifier": "PEN",
            "description": "Terza missione"
        },
        "identifier": "PEN.COMITATI",
        "code": "PEN",
        "description": "Partecipazione a comitati per la definizione di standard e norme tecniche"
    },
    "internalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "id": 30955,
                "sourceId": "3499",
                "idAb": "112929",
                "description": "DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
            },
            "role": {
                "id": 87466,
                "description": "partecipante"
            }
        },
        {
            "organizationUnit": {
                "id": 4401,
                "sourceId": "2952",
                "idAb": "110438",
                "description": "DIPARTIMENTO DI INFORMATICA, SISTEMISTICA E COMUNICAZIONE"
            },
            "role": {
                "id": 87464,
                "description": "coordinatore/organizzatore"
            }
        }
    ],
    "identifier": "PEN-0016",
    "publicEngagementLinkSet": [
        {
            "parent": {
                "id": 16765,
                "description": "BIOCCA DAY"
            },
            "child": {
                "description": "test terza missione",
                "id": 17031
            }
        }
    ],
    "wfState": {
        "id": 664,
        "description": "draft"
    },
    "partnerSet": [
        {
            "relevance": {
                "description": "nazionale",
                "id": 87469
            },
            "organizationUnit": {
                "idAb": "141090",
                "id": 38300,
                "description": "LUCAS S.R.L."
            }
        }
    ],
    "description": "descrizione clob molto lunga",
    "contributorPersonCurrentOrLastInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "description": "DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)",
                "id": 30955
            }
        }
    ],
    "geographicalImpact": {
        "id": 87472,
        "description": "regionale"
    },
    "targetDescription": "asdasdasdasd",
    "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "id": 4401,
                "description": "DIPARTIMENTO DI INFORMATICA, SISTEMISTICA E COMUNICAZIONE"
            }
        }
    ],
    "secondaryCategorySet": [
        {
            "dictionary": {
                "id": 87482,
                "description": "organizzazione di eventi pubblici"
            }
        }
    ],
    "externalFinancing": 123123123,
    "numTotalDay": 1,
    "istitutionalInitiative": false,
    "initiativeLocation": "sdfsdfsdfsdfsdf",
    "mainInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "description": "DIPARTIMENTO DI INFORMATICA, SISTEMISTICA E COMUNICAZIONE",
                "id": 4401
            }
        }
    ],
    "websiteSet": [
        {
            "url": "asdsadasdsad",
            "description": "asdasdasdasdasd"
        }
    ],
    "startDate": "2018-04-01T00:00:00",
    "activityRecipientSet": [
        {
            "dictionary": {
                "description": "altro",
                "id": 87476
            }
        }
    ],
    "totalBudget": 123123231,
    "externalPeople": "pippo pluto",
    "evaluationToolSet": [
        {
            "dictionary": {
                "description": "focus group ",
                "id": 87477
            }
        }
    ],
    "visibleOnPortal": true,
    "secondaryInternalOrganizationUnitSet": [
        {
            "organizationUnit": {
                "id": 30955,
                "description": "DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
            }
        }
    ],
    "evaluationEnable": true,
    "promoter": "asdasdasdasd",
    "periodicEvent": false
}


Centri di ricerca

METODO GET:

/gw/rest/api/research-centres

Tutti i parametri segnati con asterisco "*" possono essere usati come identificatori per ottenere una singola risorsa (single resource)

Nella versione FULL, invece, sono utilizzabili solo i paramentri contrassegnati da asterisco: gli altri vengono silenziosamente ignorati.

Campi disponibili per l'ordinamento: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Parametri della Query di richiesta:

parametrovaloredescrizione

*id

string

Stringa contenente l'id dell'ITEM

*pid

string

Stringa contenente l'identificativo persistente

[type]

string

Stringa contenente il tipo di Item. Fare riferimento all'helpdesk di IRIS per conoscere i tipi disponibili.

activeboolean

Questo parametro consente di filtrare gli oggetti basandosi sul loro stato: attivo o cessato.
Lo stato attivo o cessato viene inferito dal metadato endDate (come da documentazione di modello dell'entità di riferimento).
Gli unici valori consentiti sono true e false.
Se il parametro non viene fornito vengono ritornati tutti gli oggetti.

validation.relation

string

Valori permessi: master|mostValidated|all. Se non c'è, allora il valore default è mostValidated

year

number

Anno di creazione dell'item

wfState

string

Stringa contenente wfState dell'item

name

string

Stringa contenente la descrizione dell'item. Si può anche usare il carattere asterisco "*".

person.id

string

Stringa contenente l'IRIS person id

person.idAb

string

Stringa contenente il Person idAb

person.cf

string

Stringa contenente il Codice Fiscale

person.sourceId

string

Stringa contenente la persona, per gli Enti che non fanno uso di U-GOV

person.pid

string

Stringa contenente il Person PID (IRIS IR)

person.orcid

string

Stringa contenente il Person ORCID

person.relation

owner|contributor

Questo campo definisce una specifica relazione per una persona, e viene inteso in associazione con un altro filtro persona come ad esempio person.cf.

Se non viene definito, si prende qualsisi tipo di associazione.

department.id

string

Stringa contenente l'id Dipartimento.

department.idAb

string

Stringa contenente l'idAb Dipartimento (U-GOV).

department.sourceId

string

Stringa contenente il Dipartimento (per coloro che non hanno U-GOV).

department.relation

owner|contributor

Questo parametro permette di specificare il ruolo dipartimento: principale o secondario. I valori possibili sono solamente owner o contributor.

Questo campo va usato in associazione con altri filtri di dipartimento come ad esempio department.idAb. Se viene specificato, allora vengono restituiti solo gli item che corrispondono allo specifico dipartimento e al ruolo indicato.

Se invece il parametro non è indicato, allora vengono restituiti tutti gli item che corrispondono al dipartimento specificato.

department.match

byPerson|byDepartment

Questo parametro permette di specificare la modalità di selezione del dipartimento: per persona oppure per dipartimento. Infatti i valori possibili sono byPerson oppure byDepartment.

Il campo va usato in associazione con altri filtri di dipartimento come il department.idAb.

Se non viene fornito, allora si usano entrambi i tipi di associazione, altrimenti solo quella specificata.

L'associazione "byPerson" prende il dipartimento ATTUALE della persona (owner o contributor). L'associazione "byDepartment" risale al dipartimento che era valido nel momento della CREAZIONE dell'item.


Esempi

Per cercare tutti gli elementi:

https://<iris-host>/gw/rest/api/research-centres

Per cercare un Item con id=123456:
https://<iris-host>/gw/rest/api/research-centres?id=123456
					

Per cercare un Item con miurIdentifier=123456:

https://<iris-host>/gw/rest/api/research-centres?miurIdentifier=123456
					

Per cercare un Item il cui nome è Scienze:

https://<iris-host>/gw/rest/api/research-centres?name=Scienze
					

Per cercare un Centro di ricerca il cui proprietario ha un attuale (by person) o precedente (byDepartment) dipartimento il cui identificativo è 4400:

https://<iris-host>/gw/rest/api/research-centres?department.relation=owner&department.match=byPerson&department.id=4400

Sono disponibili le seguenti risposte:				

BASE OUTPUT: https://<iris-host>/gw/rest/api/research-centres/id=50919

Code Block
themeEclipse
titleTerza MissioneCentri di ricerca: Risposta BASE
linenumberstrue
collapsetrue
{
  "id": 50919,
  "identifyingValue": 50919,
  "pid": "RSC-0067",
  "displayValue": "test Centro di ricerca nuovo"",
  "year": 2019,
  "snapshot": true,
  "masterId": 50072,
  "mostValidated": true,
  "startDate": "2019-01-14T00:00:00",
  "endDate": "2021-01-13T00:00:00",
  "wfItemType": {
    "parentWfItemTypeSet": [
      {
        "parentWfItemTypeSet": [
          {
            "identifier": "RSC",
            "description": "Centri di ricerca",
            "priority": 12,
            "managedBy": "user"
          }
        ],
        "identifier": "RSC.UNI",
        "managedBy": "user",
        "priority": 1,
        "code": "RSC",
        "description": "Centri di ricerca universitari"
      }
    ],
    "identifier": "RSC.UNI.RIC",
    "description": "Centro di Ricerca Coordinato",
    "priority": 1,
    "code": "RSC",
    "managedBy": "user"
  },
  "wfState": {
    "id": 611,
    "description": "approved"
  },
  "ownerSet": [
    {
      "person": {
        "lastName": "Rossi",
        "firstName": "Mario",
      },
      "endDate": "2021-01-13T00:00:00",
      "startDate": "2019-01-14T00:00:00"
    }
  ],
  "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
    {
      "organizationUnit": {
        "id": 5828,
        "description": "Dipartimento di Scienze Sociali e Politiche",
        "idAb": "417"
      }
    }
  ]
}


FULL OUTPUT: https://<iris-host>/gw/rest/api/research-centres;full/id=50919

Code Block
themeEclipse
titleTerza MissioneCentri di ricerca: Risposta FULL
linenumberstrue
collapsetrue
{
  "uid": "wfItem-50072.snapshot",
  "id": 50919,
  "identifyingValue": 50919,
  "pid": "RSC-0067",
  "discriminator": "wfItem",
  "displayValue": "test Centro di ricerca nuovo"",
  "year": 2019,
  "snapshot": true,
  "masterId": 50072,
  "mostValidated": true,
  "startDate": "2019-01-14T00:00:00",
  "endDate": "2021-01-13T00:00:00",
  "lastModified": "2020-08-18T14:33:43",
  "wfItemType": {
    "parentWfItemTypeSet": [
      {
        "parentWfItemTypeSet": [
          {
            "identifier": "RSC",
            "description": "Centri di ricerca",
            "priority": 12,
            "managedBy": "user"
          }
        ],
        "managedBy": "user",
        "description": "Centri di ricerca universitari",
        "identifier": "RSC.UNI",
        "priority": 1,
        "code": "RSC"
      }
    ],
    "identifier": "RSC.UNI.RIC",
    "description": "Centro di Ricerca Coordinato",
    "managedBy": "user",
    "priority": 1,
    "code": "RSC"
  },
  "internalOrganizationUnitSet": [
    {
      "role": {
        "description": "Altre strutture coinvolte",
        "id": 92120,
        "code": "researchCentreRole.other-seats-involved"
      },
      "endDate": "2019-11-30T00:00:00",
      "organizationUnit": {
        "id": 5827,
        "description": "Dipartimento di Scienze per gli Alimenti, la Nutrizione e l'Ambiente",
        "idAb": "1011"
      },
      "startDate": "2019-07-01T00:00:00"
    },
    {
      "role": {
        "description": "Altre strutture coinvolte",
        "id": 92120,
        "code": "researchCentreRole.other-seats-involved"
      },
      "endDate": "2020-06-30T00:00:00",
      "organizationUnit": {
        "id": 5808,
        "description": "Dipartimento di Diritto Pubblico Italiano e Sovranazionale",
        "idAb": "1785"
      },
      "startDate": "2019-12-01T00:00:00"
    },
  ],
  "attachmentSet": [
    {
      "attachmentName": "test.doc",
      "attachmentOwner": {
        "id": 36001,
        "lastName": "Bianchi",
        "pid": "rp25910",
        "firstName": "Mario"
      },
      "attachmentBlob": "52bab9f7-02e7-4442-b792-24f9a99428ec",
      "attachmentType": {
        "description": "Decreto",
        "id": 92121,
        "code": "researchCenterAttachmentType.decree"
      },
      "attachmentLoadingDate": "2020-08-18T13:43:40",
      "attachmentDescription": "Attivazione"
    }
  ],
  "creator": {
    "id": 7488,
    "lastName": "Grillo",
  },
  "notes": "Attivazione: 14/01/2015",
    {
      "person": {
        "idAb": "4219",
        "ORCID": "0000-0002-1313-6965",
        "id": 8599,
        "lastName": "Leone",
        "firstName": "Marco"
      },
      "role": {
        "id": 94982,
        "code": "researchCentreContributorRole.internal-member",
        "description": "Membro interno"
      },
      "endDate": "2018-12-31T00:00:00",
      "startDate": "2018-08-31T00:00:00"
    },
  ],
  "wfState": {
    "description": "approved",
    "id": 611
  },
  "ownerSet": [
    {
      "person": {
        "lastName": "Carboni",
        "firstName": "Marta",
      },
      "endDate": "2021-01-13T00:00:00",
      "startDate": "2019-01-14T00:00:00"
    }
  ],
  "ownerPersonCurrentOrLastInternalOrganizationUnitSet": [
    {
      "organizationUnit": {
        "id": 5828,
        "idAb": "417",
        "description": "Dipartimento di Scienze Sociali e Politiche"
      }
    }
  ],
  "description": "GENDERS..."",
  "contributorPersonCurrentOrLastInternalOrganizationUnitSet": [
    {
      "organizationUnit": {
        "id": 5808,
        "description": "Dipartimento di Diritto Pubblico Italiano e Sovranazionale",
        "idAb": "1785"
      }
    },
    {
      "organizationUnit": {
        "id": 5828,
        "description": "Dipartimento di Scienze Sociali e Politiche",
        "idAb": "417"
      }
    }
  ],
  "externalCommiteeReferee": "Test",
  "historicalDescriptionSet": [
    {
      "endDate": "2018-12-31T00:00:00",
      "startDate": "2018-06-01T00:00:00",
      "description": "TEST denominazione 1"
    },
    {
      "endDate": "2017-11-20T00:00:00",
      "startDate": "2017-02-01T00:00:00",
      "description": "TEST denominazione Due"
    }
  ],
  "identifier": "RSC-0067",
  "externalReferee": "Prof.,",
  "purpose": "Genders nasce nel 1995 come ..."
}



Persone

METODO GET 

/gw/rest/api/people

Tutti i parametri contrassegnati dall'asterisco possono essere utilizzati dome identificatori per accedere a una singola risorsa.

Nella versione FULL si possono usare soltanto i parametri contrassegnati da asterisco, in quanto gli altri vengono ignorati.

Campi per l'ordinamento: id, pid, name, lastModified

Parametri della query REST

parametrovaloredescrizione

*id

string

Stringa contenente l'ID dell'elemento

name

string

Stringa contenente la descrizione dell'elemento. Si può usare anche il carattere asterisco "*".

*pid

string

Stringa contenente l'ID della Persona (IRIS IR)

*idAb

string

Stringa contenente l'IDAB della Persona

*cf

string

Stringa contenente il COdice Fiscale della Persona

*sourceId

string

Stringa contenente il souceId dato da applicazioni di terze parti. La ricerca ha luogo in tutti i campi che afferiscono a questo tipo di oggetto.

*orcid

string

Stringa contenente l'ORCID della Persona

position.match

current|notCurrent|all

Stringa contenente"current", "notCurrent" oppure "all". Restituisce gli elementi che sono attualmente attivi, quelli non attualmente attivi oppure tutti. Se non specificato, il default è tutti.

department.id

string

Stringa contenente l'identificativo del dipartimento

department.idAb

string

Stringa contenente l'identificativo idAb (U-GOV) del dipartimento


ESEMPI

Per recuperare tutti gli elementi: 

					https://<iris-host>/gw/rest/api/people
					

Per cercare l'elemento avente codice fiscale CF=ABCD


					https://<iris-host>/gw/rest/api/people?cf=ABCD


Code Block
themeEclipse
titlepayload della risposta REST
linenumberstrue
collapsetrue
[
   {
      "id":14731,
      "pid":"rp14669",
      "priorityLastPosition":{
         "supportTitle":{
            "code":"PR",
            "positionType":{
               "code":"4",
               "description":"Personale esterno ed autonomi",
               "id":"556",
               "discriminator":"support"
            },
            "description":"Professionisti",
            "id":752
         },
         "administrativeSector":{
            "id":8923,
            "positionType":{
               "description":"Personale esterno ed autonomi",
               "code":"4",
               "discriminator":"support",
               "id":"556"
            },
            "idCsa":"750",
            "description":"Settore Servizi tecnici",
            "idAb":"412"
         },
         "administrativeArea":{
            "id":627,
            "idCsa":"50",
            "positionType":{
               "id":"556",
               "description":"Personale esterno ed autonomi",
               "code":"4",
               "discriminator":"support"
            },
            "idAb":"342",
            "description":"Area dei Servizi Tecnici e di Supporto"
         },
         "identificationNumber":{
            "positionType":{
               "code":"4",
               "description":"Personale esterno ed autonomi",
               "id":"556",
               "discriminator":"support"
            },
            "id":19463,
            "description":"022729"
         }
      },
      "priorityCurrentPosition":{
         "identificationNumber":{
            "positionType":{
               "id":"556",
               "description":"Personale esterno ed autonomi",
               "discriminator":"support",
               "code":"4"
            },
            "id":19463,
            "description":"022729"
         },
         "administrativeSector":{
            "description":"Settore Servizi tecnici",
            "idAb":"412",
            "positionType":{
               "id":"556",
               "code":"4",
               "description":"Personale esterno ed autonomi",
               "discriminator":"support"
            },
            "id":8923,
            "idCsa":"750"
         },
         "supportTitle":{
            "code":"PR",
            "positionType":{
               "id":"556",
               "discriminator":"support",
               "description":"Personale esterno ed autonomi",
               "code":"4"
            },
            "id":752,
            "description":"Professionisti"
         }
      },
      "cf":"ABCD",
      "idAb":"105986",
      "lastName":"COGNOME",
      "firstName":"NOME"
   }
]


Per cercare l'elemento con idAb pari a 123456


					https://<iris-host>/gw/rest/api/people?idAb=123456&
					

Per cercare tutti i dipartimenti con idAb corrispondente a 123456:


					https://<iris-host>/gw/rest/api/people?department.idAb=123456
					
Sono disponibili le seguenti risposte:

FULL OUTPUT: https://<iris-host>/gw/rest/api/people;full/id=12345

Code Block
themeEclipse
titlePayload completo della Person (;full)
linenumberstrue
collapsetrue
{
   "uid":"person-14731",
   "id":14731,
   "pid":"rp14669",
   "discriminator":"person",
   "displayValue":"COGNOME NOME",
   "lastModified":"2018-07-30T12:20:31",
   "nationality":{
      "description":"Italia",
      "id":5608,
      "code":"IT"
   },
   "priorityLastPosition":{
      "administrativeSector":{
         "id":8923,
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "id":"556",
            "code":"4",
            "discriminator":"support"
         },
         "idCsa":"750",
         "description":"Settore Servizi tecnici",
         "idAb":"412"
      },
      "identificationNumber":{
         "positionType":{
            "code":"4",
            "description":"Personale esterno ed autonomi",
            "id":"556",
            "discriminator":"support"
         },
         "id":19463,
         "description":"022729"
      },
      "supportTitle":{
         "description":"Professionisti",
         "positionType":{
            "id":"556",
            "code":"4",
            "description":"Personale esterno ed autonomi",
            "discriminator":"support"
         },
         "code":"PR",
         "id":752
      },
      "administrativeArea":{
         "description":"Area dei Servizi Tecnici e di Supporto",
         "id":627,
         "idCsa":"50",
         "positionType":{
            "id":"556",
            "description":"Personale esterno ed autonomi",
            "code":"4",
            "discriminator":"support"
         },
         "idAb":"342"
      }
   },
   "priorityCurrentPosition":{
      "identificationNumber":{
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "discriminator":"support",
            "code":"4",
            "id":"556"
         },
         "id":19463,
         "description":"022729"
      },
      "administrativeSector":{
         "description":"Settore Servizi tecnici",
         "id":8923,
         "positionType":{
            "discriminator":"support",
            "id":"556",
            "code":"4",
            "description":"Personale esterno ed autonomi"
         },
         "idAb":"412",
         "idCsa":"750"
      },
      "supportTitle":{
         "positionType":{
            "id":"556",
            "code":"4",
            "discriminator":"support",
            "description":"Personale esterno ed autonomi"
         },
         "id":752,
         "description":"Professionisti",
         "code":"PR"
      }
   },
   "birthCountryId":{
      "code":"IT",
      "id":5608,
      "description":"Italia"
   },
   "codiceFiscaleSet":[
      {
         "startDate":"1978-02-15T00:00:00",
         "description":"PRSPLA78B15L424R"
      }
   ],
   "positionCurrentSet":[
      {
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"supportTitle"
            },
            "id":752,
            "code":"PR",
            "description":"Professionisti"
         },
         "id":6275275,
         "startDate":"2017-09-08T00:00:00",
         "positionType":{
            "code":"4",
            "id":556,
            "description":"Personale esterno ed autonomi"
         },
         "endDate":"2018-12-31T00:00:00",
         "priority":0
      },
      {
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"identificationNumber"
            },
            "id":19463,
            "description":"022729"
         },
         "id":6275277,
         "startDate":"2017-09-08T00:00:00",
         "positionType":{
            "code":"4",
            "id":556,
            "description":"Personale esterno ed autonomi"
         },
         "endDate":"2018-12-31T00:00:00",
         "priority":0
      },
      {
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"administrativeSector"
            },
            "id":8923,
            "idAb":"412",
            "description":"Settore Servizi tecnici"
         },
         "id":6275279,
         "startDate":"2017-09-08T00:00:00",
         "positionType":{
            "code":"4",
            "id":556,
            "description":"Personale esterno ed autonomi"
         },
         "endDate":"2018-12-31T00:00:00",
         "priority":0
      }
   ],
   "contactSet":[
      {
         "principal":true,
         "type":"mail",
         "description":"s98584@stud.units.it"
      }
   ],
   "positionLastSet":[
      {
         "startDate":"2015-06-15T00:00:00",
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"administrativeArea"
            },
            "description":"Area dei Servizi Tecnici e di Supporto",
            "idAb":"342",
            "id":627
         },
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "code":"4",
            "id":556
         },
         "priority":0,
         "endDate":"2017-05-15T00:00:00",
         "id":6275278
      },
      {
         "startDate":"2017-09-08T00:00:00",
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"identificationNumber"
            },
            "description":"022729",
            "id":19463
         },
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "code":"4",
            "id":556
         },
         "priority":0,
         "endDate":"2018-12-31T00:00:00",
         "id":6275277
      },
      {
         "startDate":"2017-09-08T00:00:00",
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"administrativeSector"
            },
            "description":"Settore Servizi tecnici",
            "idAb":"412",
            "id":8923
         },
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "code":"4",
            "id":556
         },
         "priority":0,
         "endDate":"2018-12-31T00:00:00",
         "id":6275279
      },
      {
         "startDate":"2017-09-08T00:00:00",
         "discriminator":"support",
         "organizationUnit":{
            "organizationUnitType":{
               "description":"supportTitle"
            },
            "description":"Professionisti",
            "code":"PR",
            "id":752
         },
         "positionType":{
            "description":"Personale esterno ed autonomi",
            "code":"4",
            "id":556
         },
         "priority":0,
         "endDate":"2018-12-31T00:00:00",
         "id":6275275
      }
   ],
   "idAb":"105986",
   "addressSet":[
      {
         "place":{
            "id":17622,
            "code":"L424",
            "description":"Trieste"
         },
         "country":{
            "code":"IT",
            "description":"Italia",
            "id":5608
         },
         "description":"PAESE 416",
         "postalCode":"34149",
         "principal":true,
         "type":"residenza"
      }
   ],
   "lastName":"COGNOME",
   "firstName":"NOME",
   "birthDate":"1978-02-15T00:00:00",
   "gender":{
      "description":"Maschile",
      "code":"M",
      "id":1041
   },
   "birthPlaceId":{
      "id":17622,
      "code":"L424",
      "description":"Trieste"
   },
   "cf":"XXXYYY77P55F205F"
}


BASE OUTPUT: https://<iris-host>/gw/rest/api/people?id=12345

Premi della ricerca

METODO GET 

/gw/rest/api/prizes

Tutti i parametri contrassegnati dall'asterisco possono essere utilizzati dome identificatori per accedere a una singola risorsa.

Nella versione FULL si possono usare soltanto i parametri contrassegnati da asterisco, in quanto gli altri vengono ignorati.

Campi per l'ordinamento: id, pid, name, lastModified

Parametri della query REST

parametrovaloredescrizione

*id

string

Stringa contenente l'ID dell'elemento

*pid

string

Stringa contenente l'identificatore persistente

*miurIdentifier

string

Stringa contenente il numero miurIdentifier dell'elemento che è stato assegnato dal MIUR

name

string

Stringa contenente la descrizione dell'elemento. Si può usare anche l'asterisco "*"


ESEMPI

Per recuperare tutti gli elementi: 


					https://<iris-host>/gw/rest/api/prizes
					

Per trovare l'item con ID pari a 123456:


					https://<iris-host>/gw/rest/api/prizes?id=123456
					

Per trovare l'item con miurIdentifier pari a 123456:


					https://<iris-host>/gw/rest/api/prizes?miurIdentifier=123456
					

Per trovare l'elemento Scienze:


					https://<iris-host>/gw/rest/api/prizes?name=Scienze
					
Sono disponibili le seguenti risposte:

BASE OUTPUT: https://<iris-host>/gw/rest/api/prizes/id=12345

Code Block
themeEclipse
titlePremi: risposta BASE
linenumberstrue
collapsetrue
{
    "id": 21,
    "displayValue": "Premio Nobel per la fisica",
    "country": {
        "code": "SWE",
        "description": "Svezia",
        "id": 3337
    },
    "prizeDescriptionSet": [
        {
            "awarder": "The Royal Swedish Academy of Sciences, Stockholm, Sweden"
        }
    ],
    "awarder": "Accademia Reale Svedese delle Scienze, Stoccolma",
    "miurIdentifier": "2"
}

FULL OUTPUT: https://<iris-host>/gw/rest/api/prizes;full/id=12345

Code Block
themeEclipse
titlePremi: risposta FULL
linenumberstrue
collapsetrue
{
    "uid": "rmItem-21",
    "id": 21,
    "discriminator": "rmItem",
    "displayValue": "Premio Nobel per la fisica",
    "lastModified": "2017-12-04T16:58:14",
    "lang": {
        "code": "ita",
        "description": "Italian",
        "id": 6523
    },
    "prizeDescriptionSet": [
        {
            "lang": {
                "code": "eng",
                "description": "English",
                "id": 5725
            },
            "awarder": "The Royal Swedish Academy of Sciences, Stockholm, Sweden",
            "name": "The Nobel Prize in Physics",
            "description": "The Nobel Prize for Physics"
        }
    ],
    "keywordSet": [
        {
            "lang": {
                "code": "eng",
                "description": "English",
                "id": 5725
            },
            "description": "physics"
        },
        {
            "lang": {
                "code": "ita",
                "description": "Italian",
                "id": 6523
            },
            "description": "fisica"
        },
        {
            "lang": {
                "code": "ita",
                "description": "Italian",
                "id": 6523
            },
            "description": "Nobel"
        }
    ],
    "country": {
        "description": "Svezia",
        "code": "SWE",
        "id": 3337
    },
    "rmItemType": {
        "description": "prize",
        "id": 2
    },
    "miurIdentifier": "2",
    "relevance": {
        "id": 26580,
        "code": "1",
        "description": "Internazionale"
    },
    "url": "http://www.nobelprize.org/nobel_prizes/physics/",
    "awarder": "Accademia Reale Svedese delle Scienze, Stoccolma",
    "description": "Premio Nobel per la fisica"
}


Biblioteche

METODO GET 

/gw/rest/api/libraries

Tutti i parametri contrassegnati dall'asterisco possono essere utilizzati come identificatori per accedere a una singola risorsa.

Nella versione FULL si possono usare soltanto i parametri contrassegnati da asterisco, in quanto gli altri vengono ignorati.

Campi per l'ordinamento: id, pid, name, startDate, lastModified

Parametri della query REST

parametrovaloredescrizione

*id

string

Stringa contenente l'ID dell'elemento

*pid

string

Stringa contenente l'identificatore persistente

*idAb

string

Stringa contenente l'IdAb dell'elemento assegnato da U-GOV

*sourceId

string

Stringa contenente il sourceId dell'elemento dato da altre applicazioni

name

string

Stringa contenente la descrizione dell'elemento. Si può usare anche il carattere asterisco "*"

ESEMPI:

Per recuperare tutti gli elementi: 


					https://<iris-host>/gw/rest/api/libraries
					

Per trovare l'item con ID pari a 123456:


					https://<iris-host>/gw/rest/api/libraries?id=123456
					

Per trovare l'item idAb pari a 123456:


					https://<iris-host>/gw/rest/api/libraries?idAb=123456
					

Per trovare l'elemento Scienze:


					https://<iris-host>/gw/rest/api/libraries?name=Scienze
					
Sono disponibili le seguenti risposte:

BASE OUTPUT: https://<iris-host>/gw/rest/api/libraries/id=12345

Code Block
themeEclipse
titleBiblioteche: risposta base
linenumberstrue
collapsetrue
{
    "id": 1727,
    "displayValue": "ex-BIBLIOTECA CENTRALE",
    "sourceId": "1112",
    "idAb": "112079"
}

FULL OUTPUT: https://<iris-host>/gw/rest/api/libraries;full/id=12345 

Code Block
themeEclipse
titleBiblioteche: risposta FULL
linenumberstrue
collapsetrue
{
    "uid": "organizationUnit-1727",
    "id": 1727,
    "discriminator": "organizationUnit",
    "displayValue": "ex-BIBLIOTECA CENTRALE",
    "lastModified": "2015-12-30T00:00:00",
    "sourceType": "STRUTTURE",
    "sourceId": "1112",
    "idAb": "112079",
    "organizationUnitType": {
        "description": "library",
        "id": 154
    },
    "description": "ex-BIBLIOTECA CENTRALE",
    "sourceSubtype": "BIB",
    "abbreviation": "BIBLIOTECA CENTRALE"
}

Riviste

METODO GET 

/gw/rest/api/prizes

Tutti i parametri contrassegnati dall'asterisco possono essere utilizzati dome identificatori per accedere a una singola risorsa.

Nella versione FULL si possono usare soltanto i parametri contrassegnati da asterisco, in quanto gli altri vengono ignorati.

Campi per l'ordinamento: id, pid, name, lastModified

Parametri della query REST

parametrovaloredescrizione

*id

string

Stringa contenente l'ID dell'elemento

*pid

string

Stringa contenente l'identificatore persistente dell'elemento

*code

string

Stringa contenente il codice dell'elemento

*issn

string

Stringa contenente l'ISSN dell'elemento

nature

string

Stringa contenente il codice della natura dell'elemento

country

string

Stringa contenente il codice del paese dell'elemento

name

string

Stringa contenente la descrizione dell'elemento. Si può usare anche il carattere asterisco "*"

ESEMPI:

Per recuperare tutti gli elementi: 


					https://<iris-host>/gw/rest/api/journals
					

Per l'elemento avente ID 123456


					https://<iris-host>/gw/rest/api/journals?id=123456
					

Per l'elemento avente idAb 123456


					https://<iris-host>/gw/rest/api/journals?idAb=123456
					

Per l'elemento avente nome pari a Scienze:


					https://<iris-host>/gw/rest/api/journals?name=Scienze
					
Sono disponibili le seguenti risposte:

BASE OUTPUT: https://<iris-host>/gw/rest/api/journals/id=12345

Code Block
themeEclipse
titleRiviste: risposta BASE
linenumberstrue
collapsetrue
{
    "id": 54,
    "displayValue": "ENCYCLOPAIDEIA",
    "country": "IT",
    "nature": "R",
    "publisher": "Dal 1999 l'editore è :\nBologna: CLUEB Editrice. \n\nPrecedente:\n Il Segnalibro (Torino)",
    "code": "E187971",
    "issn": "1590-492X"
}


FULL OUTPUT: https://<iris-host>/gw/rest/api/journals;full/id=12345

Code Block
themeEclipse
titleRiviste: risposta FULL
linenumberstrue
collapsetrue
{
    "uid": "rmItem-54",
    "id": 54,
    "discriminator": "rmItem",
    "displayValue": "ENCYCLOPAIDEIA",
    "lastModified": "2017-04-13T11:23:14",
    "sottotitolo": "RIVISTA DI FENOMENOLOGIA, PEDAGOGIA, FORMAZIONE",
    "startYear": 1997,
    "country": "IT",
    "nature": "R",
    "publisher": "Dal 1999 l'editore è :\nBologna: CLUEB Editrice. \n\nPrecedente:\n Il Segnalibro (Torino)",
    "rmItemType": {
        "description": "journal",
        "id": 5
    },
    "description": "ENCYCLOPAIDEIA",
    "code": "E187971",
    "titolo_chiave": "ENCYCLOPAIDEIA (BOLOGNA)",
    "miurIdentifier": "E187971",
    "issn": "1590-492X",
    "abbreviato": "ENCYCLOPAIDEIA"
}


Pubblicazioni

Il formato della risposta REST è diverso da quello delle altre API. Questa parte verrà dismessa e riorganizzata nel corso del 2020.

METODO GET 

/gw/rest/api/publications.tmp

Campi per l'ordinamento: bi_sort_2_sort

Parametri di Request:

parametrovaloredescrizione

authority.people_authority

string

Recupera le pubblicazioni dell'autore identificato dall'RPID

param.item.selected

string

Recupera le pubblicazioni scelte come pubblicazioni "TOP" dall'autore identificato dall'RPID

handle

string

Recupera le pubblicazioni dato uno specifico handle

ESEMPI:

Per tutte le pubblicazioni:


						https://<iris-host>/gw/rest/api/publications.tmp
					

Per le pubblicazioni il cui autore è identificato da RP=rp03683:


						https://<iris-host>/gw/rest/api/publications?authority.people_authority=rp03683
					

Per le cinque "TOP PUBLICATIONS" il cui autore è identificato da RP=rp03683


						https://<iris-host>/gw/rest/api/publications?item.selected=rp03683&pageSize=5
					

Le risposte prevedono solo il formato base:

Code Block
themeEclipse
titlePubblicazioni: risposta BASE
linenumberstrue
collapsetrue
{
    "count": "5",
    "page": "1",
    "pageSize": "20",
    "sort": "null",
    "sortDir": "null",
    "resultList": [
        {
            "handle": "10999/18124",
            "dc.identifier.citation": "Rossi, B., & Marrone, I. (2007). Conoscere, condividere, cambiare. Idee per una intranet 2.0 alla biblioteca di Hannover. In A. Passone, & G. Tatò (a cura di), Archivio di Stato di Trieste. Giornate di confronto 2004-2006, Trieste, AIB-ANAI. Monfalcone : AIB-ANAI."
        },
        {
            "handle": "10999/5113",
            "dc.identifier.citation": "Rossi, B. (2009). Sticking between: i mashup nelle biblioteche. In Da XML all'elaborazione di conoscenza:\napprocci professionali e uso sociale della rete (Edizione italiana dell'International Italian Forum, Londra, Online Information Meeting 2006) (pp.71-86). AIDA."
        },
        {
            "handle": "10999/5114",
            "dc.identifier.citation": "di Verdi, M., Marrone, I., Bianchi, G., Rossi, B., De Gialli, F., & Azzurri, B. (2006). Visioni e prospettive da una Biblioteca d'Autore: la Biblioteca di Ateneo dell'Università di Hannover, Sede Centrale [Video]."
        },
        {
            "handle": "10999/5117",
            "dc.identifier.citation": "Rossi, B. (2009). Behind the Scenes: Some Technical Details. In N. Engard (a cura di), Library Mashups: Exploring new ways to deliver library data (pp. 19-33). Information Today."
        },
        {
            "handle": "10999/213721",
            "dc.identifier.citation": "Rossi, B. (2017). Peer review recognition e comunicazione scientifica: nuovi modelli di accountability. In La biblioteca aperta : tecniche e strategie di condivisione : scenari e tendenze : convegno Milano 16-17 marzo 2017 (pp.96-106)."
        }
    ]
}