Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: IRIS-24909: Aggiunta parte grandi attrezzature

...

					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.


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.

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:

...