...
Parametri della Query di richiesta:
| parametro | valore | descrizione |
|---|---|---|
*id | Stringa contenente l'id dell'ITEM | |
*pid | Stringa contenente l'identificativo persistente | |
[type] | Stringa contenente il tipo di Item. Fare riferimento all'helpdesk di IRIS per conoscere i tipi disponibili. | |
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 dell'item | |
name | Stringa contenente la descrizione dell'item. Si può anche usare il carattere asterisco "*". | |
person.id | Stringa contenente l'IRIS person id | |
person.idAb | Stringa contenente il Person idAb | |
person.cf | Stringa contenente il Codice Fiscale | |
person.sourceId | Stringa contenente la persona, per gli Enti che non fanno uso di U-GOV | |
person.pid | Stringa contenente il Person PID (IRIS IR) | |
person.orcid | 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 | Stringa contenente l'id Dipartimento. | |
department.idAb | Stringa contenente l'idAb Dipartimento (U-GOV). | |
department.sourceId | 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:
...
- BASE OUTPUT: https://<iris-host>/gw/rest/api/public-engagements/id=12345
- FULL OUTPUT: https://<iris-host>/gw/rest/api/public-engagements;full/id=12345
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 asteriscati, in quanto gli altri vengono ignorati.
Campi per l'ordinamento: id, pid, name, lastModified
Parametri della query REST
| parametro | valore | descrizione |
|---|---|---|
*id | Stringa contenente l'ID dell'elemento | |
name | Stringa contenente la descrizione dell'elemento. Si uò usare anche il carattere asterisco "*". | |
*pid | Stringa contenente l'ID della Persona (IRIS IR) | |
*idAb | Stringa contenente l'IDAB della Persona | |
*cf | Stringa contenente il COdice Fiscale della Persona | |
*sourceId | 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 | 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 | Stringa contenente l'identificativo del dipartimento | |
department.idAb | Stringa contenente l'identificativo idAb (U-GOV) del dipartimento |
ESEMPI
Per recuperare tutti gli elementi:
https://<iris-host>/gw/rest/api/people
To search Item with CF like 123456
https://<iris-host>/gw/rest/api/people?cf=UYGUSGAUYGUGY| Code Block | ||
|---|---|---|
| ||
[
{
"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":"PRSPLA78B15L424R",
"idAb":"105986",
"lastName":"PRESTIGIOVANNI",
"firstName":"PAOLO"
}
] |
To search all the people with idAb like 123456
https://<iris-host>/gw/rest/api/people?idAb=123456&
To search all the deprtment with idAb like 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 [expand]
BASE OUTPUT: https://<iris-host>/gw/rest/api/people?id=12345 [expand]