...
- payload complessi per i quali si rimanda alla documentazione di modello (cliccare su ogni elemento del seguente elenco):
- payload complessi non ricostruibili da documentazione di modello:
- Persone
- Premi
- Biblioteche
- Riviste
- Pubblicazioni
- payload semplici (assimilabili a dizionari) NON ricostruibili da documentazione di modello:
- SSD
- Macrosettori concorsuali
- Settori concorsuali
- Dipartimenti
- Organizzazioni esterne
- Facoltà
- Ruoli delle persone
- 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.
Parametri della Query di richiesta:
parametro | valore | descrizione |
---|---|---|
*id | Stringa con l'identificativo ID dell'item | |
*pid | Stringa con l'identificatore persistente | |
[macrotype] | Stringa contenente il macro tipo dell'elemento. Per conoscere tutti i possibili valori, contattare l'helpdesk del gruppo di supporto IRIS | |
[type] | Stringa contenente il tipo dell'elemento. Per conoscere tutti i possibili valori, contattare l'helpdesk del gruppo di supporto IRIS | |
validation.relation | Valori permessi: master|mostValidated|all. Se non c'è, allora il valore default è mostValidated | |
visibleOnPortal | 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] | Anno di creazione dell'item | |
[wfState] | Stringa contenente wfState (stato del workflow) dell'item. | |
name | Stringa contenente la descrizione dell'item. È possibile cercare col carattere "*". | |
person.id | Stringa contenente l'id IRIS della Persona | |
person.idAb | Stringa contenente l'idAb della Persona | |
person.cf | Stringa contenente il Codice Fiscale della Persona | |
person.sourceId | Stringa contenente l'identificativo sorgente della Persona, per coloro che non fanno uso di U-gov | |
person.pid | Stringa contenente il Person PID di IRIS modulo IR. | |
person.orcid | 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 | Stringa contenente l'id del parametro | |
department.idAb | Stringa contenente l'idAb U-gov del dipartimento. | |
department.sourceId | 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
Terza missione (publicEngagement - PEN)
METODO GET 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)
...
Campi per l'ordinamento: bi_sort_2_sort
Parametri di Request:
parametro | valore | descrizione |
---|---|---|
authority.people_authority | Recupera le pubblicazioni dell'autore identificato dall'RPID | |
param.item.selected | Recupera le pubblicazioni scelte come pubblicazioni "TOP" dall'autore identificato dall'RPID | |
handle | Recupera le pubblicazioni dato uno specifico handle |
ESEMPI:
Per tutte le pubblicazioni:
...