CINECA logo IRIS logo

IRIS GW (Gateway) REST API documentation (v1)

This is the reference document for the IRIS GW REST API.

These APIs are designed to be used by developers to retrieve IRIS information and use it within other applications.

At the moment these APIs cover extensively resources from IRIS RM and IRIS AP modules.
There is a further API for retrieving publications (IRIS IR)
This is a temporary API developed awaiting next version of IRIS IR that will have DSpace6 as its core and that is due for the end of 2019.

GW REST APIs are accessible via a web browser but is recommended the use of a specific client or browser plugins (there are several plugins for Mozilla Firefox, Google Chrome, ...)

If it's your first reading it's recommended to go through the document otherwise you can skip to the REST Service Details

Back to summary

At a glance

Authentication and Authorization

To access GW REST API must be used HTTP Basic Authentication over https.
A specific account is needed and can be provided by IRIS Staff, upon request.

Back to summary

REST URIs Conventions

GW REST APIs provide access to resources (data entities) via URI paths according to REST conventions and HTTP RFC standards.
All the responses are in JSON format and as of version v1 only GET requests are allowed.
GW REST API URIs follow this pattern:

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

All available resource-collection-name are detailed in the following sections.
To get the list of all resources in a collection the constructed URL must follow this pattern
http://<iris-host>/gw/rest/api/<resource-collection-name>
The list can be filtered by using query parameters as explained in this section
To get a single resource the constructed URL must follow this pattern
http://<iris-host>/gw/rest/api/<resource-collection-name>/<resource-identifier>
Refer to this section to get details about the use of identifiers.

As an example, to retrieve the list of all departments, you would access:

https://air.unimi.it/gw/rest/api/departments

To retrieve a specific department (department identified by 328235 for instance), you would access:

https://air.unimi.it/gw/rest/api/departments/328235

Almost all available resource collections are provided in two "flavours":

According to REST conventions:

Back to summary

REST filtering parameters

GW REST requests can specify various filtering parameters that vary from collections to collections.
Standard query parameters are allowed for collections and single resource requests.
For example:

All available filter parameters for every resource type are listed in the specific section for each collection.

REST conventions don't specify how to construct an URL to get a specific resource when this resource has multiple identifiers.
To fulfil this requirement, GW REST APIs allow to specify which identifier you want to use when making a request.
For example to get a single person one of the following URLs are usable:

Each of the previous requests return a single JSON object {}. The same result can be obtained making these requests: Each of the previous requests return a JSON array containing the matched object [{}].

All available identifiers for every resource type are listed in the specific section for each collection.
If no identifier type is supplied, the usage of "id" identifier is implied.

Back to summary

REST Responses Conventions

Every time a request is made, the body result (payload) will contain only information relative to the resource. Other information such errors, paging, sorting are available in HTTP headers (more details) These headers are:

Back to summary

REST Paging and Sorting Results

For navigating and sorting results, these request query parameters can be used

For instance: The usable fields for sorting are: The actual usable sorting filters for a specific resource type are specified in the REST Service Details

Back to summary

REST Error Handling

Every time a request is made, one of these HTTP Response Header can be returned:

If an Internal Server Error is returned can be used these headers to dig into the problem: In a future release, these header could be renamed to Error-Code and Error-Message respectively.

Back to summary

REST Resource Versioning

In IRIS there are some resources that are version-enabled. Consider this use case that clarify the scenario.
A researcher creates an item (workgroup, laboratory, public-engagement, ...), and add some info: this item is known as the master item.
At some point he/she decides to mark this item as "approved": this is the moment in which a "snapshot" is generated to freeze the information. So now we have two versions of the same item: the master item (approved) and the snapshot one(approved). Some days later he/she catches a typo and reopens that item or more precisely reopens the master item because the snapshot is freezed. Still we have two versions of the same item: the master(reopened) item and the snapshot one(approved). Now he/she decides to mark again this item as "approved": at this precise moment a new snapshot is created. Now we have three versions of the same item: the master item (approved) and two snapshot ones (approved). Every cycle reopen/approve generates a new snapshot. The REST Services exposes only the master item and the last snapshot if available. To simplify the query writing two new concept are introduced

Not all resources are versioned, but when they are, this additional filter parameter can be used: If no validation.relation parameter is provided validation.relation=mostValidated is assumed.
Recall that ids are generated for every snapshot and master items. The items visible in IRIS RM or IRIS AP are shown by master id.
Snapshot ids are available in "Versioni" tab.

Back to summary

REST Endpoint Versioning

Every collection endpoint can be versioned.
The current version is v1.
If not otherwise specified version v1 is assumed.
To use a specific version, a version number can be specified via one of

Back to summary

REST File Retrieval

Some resources might expose information about attached files.
The following image shows the payload for an object containing references to files.


To retrieve the file must be used the service /gw/rest/api/files/{blobId} where {blobId} must be replace with the actual file identifier.
In the example above, to retrieve the file the service to be invoked would be /gw/rest/api/files/117626bd-9f00-4bf5-b20c-947fae171afa

To guarantee better performance in live approach it's advisable to invoke the service specifying the following query parameter:

The previous information DOES NOT APPLY to publications (/gw/rest/api/products)

Back to summary

REST Service Details

In this section are listed all the available resource collections.
For each collections the following info are specified:

Back to summary

Resource Source Endpoint Method Base Full Versioned File Cache Description
Files RM/AP https://air.unimi.it/gw/rest/api/files/{blobId} GET X This service allows the retrieval of a file by blobId
For more information refer to REST File Retrieval section
WfItemTypes (Tipologia di oggetti con flusso di validazione di RM e AP) RM/AP https://air.unimi.it/gw/rest/api/wf-item-types GET X This collection contains all the types of object in IRIS AP and IRIS RM
Projects (Progetti di ricerca) AP https://air.unimi.it/gw/rest/api/projects GET X X wf This collection contains all the projects (Progetti di ricerca) extracted from IRIS AP
Calls (Bandi di finanziamento) AP https://air.unimi.it/gw/rest/api/calls GET X X wf This collection contains all the calls for proposal (Bandi di finanziamento) extracted from IRIS AP
Contracts (Contratti e convenzioni) AP https://air.unimi.it/gw/rest/api/contracts GET X X wf This collection contains all the contracts and conventions (Contratti) extracted from IRIS AP
Equipments (Grandi attrezzatture) RM https://air.unimi.it/gw/rest/api/equipments GET X X X wf This collection contains all the equipments (Grandi Attrezzature) extracted from IRIS RM
Incoming people (Mobilità in ingresso) RM https://air.unimi.it/gw/rest/api/incoming-people GET X X wf This collection contains all the incoming people (Mobilità in ingresso) extracted from IRIS RM
Internal Organizations (Organizzazioni interne) RM https://air.unimi.it/gw/rest/api/internal-organizations GET X rm This collection contains all the internal organizations from IRIS RM
Laboratories (Laboratori) RM https://air.unimi.it/gw/rest/api/laboratories GET X X X wf This collection contains all the laboratories (Laboratori) extracted from IRIS RM
Libraries (Biblioteche) RM https://air.unimi.it/gw/rest/api/libraries GET X X rm This collection contains all the libraries (Biblioteche) extracted from IRIS RM
People (Persone) RM https://air.unimi.it/gw/rest/api/people GET X X rm This collection contains all the people (Personale di Ateneo) extracted from IRIS RM
Prizes (Premi della ricerca) RM https://air.unimi.it/gw/rest/api/prizes GET X X rm This collection contains all the prizes (Premi della ricerca) extracted from IRIS RM
Public Engagements (Iniziative di Public engagements - Terza Missione) RM https://air.unimi.it/gw/rest/api/public-engagements GET X X X wf This collection contains all the public engagements initiatives (Iniziative di public engagements - Terza Missione) extracted from IRIS RM
Research Centres (Centri di ricerca) RM https://air.unimi.it/gw/rest/api/research-centres GET X X X wf This collection contains all the research centres (Centri di ricerca) extracted from IRIS RM
Continuous Trainings (Corsi di Formazione Continua - Terza Missione) RM https://air.unimi.it/gw/rest/api/continuous-trainings GET X X wf This collection contains all the continuous training courses (Corsi di Formazione Continua - Terza Missione) extracted from IRIS RM
Workgroups (Gruppi di ricerca) RM https://air.unimi.it/gw/rest/api/workgroups GET X X X wf This collection contains all the workgroups (Gruppi di ricerca) extracted from IRIS RM
Patents (Brevetti) RM https://air.unimi.it/gw/rest/api/patents GET X X X wf This collection contains all the patents (Brevetti) extracted from IRIS RM
Academic Fields (SSD PRE riforma 2000) RM https://air.unimi.it/gw/rest/api/academic-fields GET X This collection contains all the academic fields (SSD pre riforma 2000) extracted from IRIS RM
Academic Fields 2000 (SSD POST riforma 2000) RM https://air.unimi.it/gw/rest/api/academic-fields-2000 GET X This collection contains all the academic fields (SSD post riforma 2000) extracted from IRIS RM
Academic Areas (Macrosettori Concorsuali) RM https://air.unimi.it/gw/rest/api/academic-areas GET X This collection contains all the academic groups (Macrosettori Concorsuali) extracted from IRIS RM
Academic Groups (Settori Concorsuali) RM https://air.unimi.it/gw/rest/api/academic-groups GET X This collection contains all the academic groups (Settori Concorsuali) extracted from IRIS RM
Departments (Dipartimenti) RM https://air.unimi.it/gw/rest/api/departments GET X rm This collection contains all the departments of the University (Dipartimenti) extracted from IRIS RM
External Organizations (Organizzazioni esterne) RM https://air.unimi.it/gw/rest/api/external-organizations GET X X rm This collection contains all the external organizations with which the University has some kind of collaboration (Organizzazioni esterne) extracted from IRIS RM
Faculties (Facoltà) RM https://air.unimi.it/gw/rest/api/faculties GET X rm This collection contains all the faculties (Facoltà) extracted from IRIS RM
Journals (Riviste) RM https://air.unimi.it/gw/rest/api/journals GET X rm This collection contains all the journals (Riviste) extracted from IRIS RM
Person roles (Ruoli delle persone) RM https://air.unimi.it/gw/rest/api/person-roles GET X This collection contains all the person roles (Ruoli delle persone) extracted from IRIS RM
Person titles (Profili delle persone) RM https://air.unimi.it/gw/rest/api/person-titles GET X This collection contains all the person titles (Profili delle persone) extracted from IRIS RM
Publications (Pubblicazioni) IR https://air.unimi.it/gw/rest/api/products GET X This collection contains all the publicly visible publications (Publications) extracted from IRIS IR.
Asns (ASN) BI https://air.unimi.it/gw/rest/api/asns GET X This collection contains all the ASN reports extracted from IRIS BI.
Asns - PDF (ASN) BI https://air.unimi.it/gw/rest/api/asns/{asnId}/pdf GET X This collection expose the pdf report for ASN

/gw/rest/api/wf-item-types

Methods

GET 

/gw/rest/api/wf-item-types

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section

All parameters surrounded by square brackets [...] accept multiple values.
Available sort fields: id, pid, name, priority

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

parent.pid

string

a String containing the persistent identifier of the parent node

enabledRootTypesOnly

boolean

This parameter filters the root types and returns only enabled ones for that specific instance

actuallyUsed

boolean

This parameter filters types returning only the ones for which exist some items of that type

Back to summary

/gw/rest/api/academic-areas

Methods

GET 

/gw/rest/api/academic-areas

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*code

string

a String containing the code of the item. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. Return the items that match with current string. "*" can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/academic-areas
					
To search Item with code equals to 123456

					https://air.unimi.it/gw/rest/api/academic-areas?code=123456
					
To search Item with sourceId equals to 123456

					https://air.unimi.it/gw/rest/api/academic-areas?sourceId=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/academic-areas?name=Scienze*
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
    	  "id":15,
    	  "displayValue":"01 - Scienze matematiche e informatiche",
    	  "sourceId":"01",
    	  "code":"01"
       }
    ]
                                    

Back to summary

/gw/rest/api/academic-fields

Methods

GET 

/gw/rest/api/academic-fields

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*code

string

a String containing the code of the item. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/academic-fields
					
To search Item with code like 123456

					https://air.unimi.it/gw/rest/api/academic-fields?code=123456
					
To search Item with sourceId like 123456

					https://air.unimi.it/gw/rest/api/academic-fields?sourceId=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/academic-fields?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":392,
          "displayValue":"04/A3 - GEOLOGIA APPLICATA, GEOGRAFIA FISICA E GEOMORFOLOGIA",
          "sourceId":"04/A3",
          "code":"04/A3"
       }
    ]
                                    

Back to summary

/gw/rest/api/academic-fields-2000

Methods

GET 

/gw/rest/api/academic-fields-2000

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*code

string

a String containing the code of the item. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/academic-fields-2000
					
To search Item with code like 123456

					https://air.unimi.it/gw/rest/api/academic-fields-2000?code=123456
					
To search Item with sourceId like 123456

					https://air.unimi.it/gw/rest/api/academic-fields-2000?sourceId=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/academic-fields-2000?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":392,
          "displayValue":"04/A3 - GEOLOGIA APPLICATA, GEOGRAFIA FISICA E GEOMORFOLOGIA",
          "sourceId":"04/A3",
          "code":"04/A3"
       }
    ]
                                    
Back to summary

/gw/rest/api/academic-groups

Methods

GET 

/gw/rest/api/academic-groups

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*code

string

a String containing the code of the item. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/academic-groups
					
To search Item with code like 123456

					https://air.unimi.it/gw/rest/api/academic-groups?code=123456
					
To search Item with sourceId like 123456

					https://air.unimi.it/gw/rest/api/academic-groups?sourceId=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/academic-groups?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":392,
          "displayValue":"04/A3 - GEOLOGIA APPLICATA, GEOGRAFIA FISICA E GEOMORFOLOGIA",
          "sourceId":"04/A3",
          "code":"04/A3"
       }
    ]
                                    

Back to summary

/gw/rest/api/asns

Methods

GET 

/gw/rest/api/asns
Request Query Parameters
parameter value description

personId

Integer

an integer containing the ID of the person. See response for values

discriminator

String

a string containing the discriminator of the report. See response for values

codiceFiscale

String

a string containing the codice fiscale of the person. See response for values

academicFieldId

Integer

an integer containing the ID of the academic field - settore concorsuale. See response for values

academicField2000Id

Integer

an integer containing the ID of the academic field 2000 - settore SSD. See response for values

isBiblio

Integer

an integer: 1 for biblio, 0 for non biblio. See response for values

roleId

Integer

an integer containing the ID of the role. See response for values

departmentId

Integer

an integer containing the ID of the department. See response for values

academicAreaId

Integer

an integer containing the ID of the academic area. See response for values

facultyId

Integer

an integer containing the ID of the faculty. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/asns
					
To search Item for a person, given his codice fiscale

					https://air.unimi.it/gw/rest/api/asns?codiceFiscale=AAABBB50A99E209K
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    								[
    									{
    									"asnId": "AUTO_2023-101-102-103",
    									"discriminator": "AUTO_2023",
    									"rmPersonId": 101,
    									"academifFieldId": 102,
    									"academifFieldCode": "01/A3",
    									"academifField2000Id": 103,
    									"academifField2000Code": "MAT/05",
    									"lastName": "COGNOME",
    									"firstName": "NOME",
    									"role": "Docenti di ruolo di Ia fascia",
    									"department": "Dipartimento di TEST",
    									"academicArea": "AREA MIN. 01 - Scienze matematiche e informatiche",
    									"academifField": "01/A3 - ANALISI MATEMATICA, PROBABILITÀ E STATISTICA MATEMATICA",
    									"academifField2000": "Settore MAT/05 - Analisi Matematica",
    									"isBiblio": 1,
    									"flagCa2": 1,
    									"flagCa1": 1,
    									"flagAc": 1,
    									"ca2Index1Description": "Numero articoli ultimi 5 anni",
    									"ca2Index1Value": 12,
    									"ca2Index1Threshold": 8,
    									"ca2Index1Flag": 1,
    									"ca2Index2Description": "Numero citazioni ultimi 10 anni",
    									"ca2Index2Value": 419,
    									"ca2Index2Threshold": 56,
    									"ca2Index2Flag": 1,
    									"ca2Index3Description": "H index ultimi 10 anni",
    									"ca2Index3Value": 10,
    									"ca2Index3Threshold": 5,
    									"ca2Index3Flag": 1,
    									"ca1Index1Description": "Numero articoli ultimi 10 anni",
    									"ca1Index1Value": 22,
    									"ca1Index1Threshold": 10,
    									"ca1Index1Flag": 1,
    									"ca1Index2Description": "Numero citazioni ultimi 15 anni",
    									"ca1Index2Value": 654,
    									"ca1Index2Threshold": 84,
    									"ca1Index2Flag": 1,
    									"ca1Index3Description": "H index ultimi 15 anni",
    									"ca1Index3Value": 15,
    									"ca1Index3Threshold": 6,
    									"ca1Index3Flag": 1,
    									"acIndex1Description": "Numero articoli ultimi 10 anni",
    									"acIndex1Value": 22,
    									"acIndex1Threshold": 15,
    									"acIndex1Flag": 1,
    									"acIndex2Description": "Numero citazioni ultimi 15 anni",
    									"acIndex2Value": 654,
    									"acIndex2Threshold": 167,
    									"acIndex2Flag": 1,
    									"acIndex3Description": "H index ultimi 15 anni",
    									"acIndex3Value": 15,
    									"acIndex3Threshold": 8,
    									"acIndex3Flag": 1,
    									"codiceFiscale": "AAABBB50A99E209K",
    									"identificationNumber": "0123456"
    									}
    								]
                                    

Back to summary

/gw/rest/api/asns/{asnId}/pdf

Methods

GET 

/gw/rest/api/asns/{asnId}/pdf
Request Path Parameters
parameter value description

asnId

String

a String containing the ID of the ASN reports. The value can be retrieved with the /gw/rest/api/asns end-point

Examples:
To download a report

					https://air.unimi.it/gw/rest/api/asns/AUTO_2022-0-1-2/pdf
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    								byte[]
                                    

Back to summary

/gw/rest/api/departments

Methods

GET 

/gw/rest/api/departments

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*idAb

string

a String containing the idAb number of the item. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/departments
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/departments?id=123456
					
To search Item with idAb like 123456

					https://air.unimi.it/gw/rest/api/departments?idAb=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/departments?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":1857,
          "displayValue":"EX-DIPARTIMENTO DI NEUROSCIENZE E TECNOLOGIE BIOMEDICHE-(1998/2012)",
          "sourceId":"1174",
          "idAb":"100140"
       }
    ]
                                    

Back to summary

/gw/rest/api/equipments

Methods

GET 

/gw/rest/api/equipments

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values. For example https://air.unimi.it/gw/rest/api/equipments?type=2018&year=2019
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

[year]

number

Item create year

[wfState]

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This parameter allows to specify the relation of ther person with this item. Only owner|contributor values are allowed. This field must be used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

userType

string

This parameter allows to specify the userType dictionary. If specified, the items that contain the specified dictionary with the specific code are returned. It's possible to specify more than one value, in which case will be returned all the items that contain at least one of them. To see all the codes linked to the dictionaries, search "RM - ATTREZZATURE - UTENZA" in the application page that manage all the dictionaries See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/equipments
					
To search person with CF like 123456

					https://air.unimi.it/gw/rest/api/equipments?person.cf=UYGUSGAUYGUGY					
					
To search person with position owner of equipment and CF like XXXXXXX

					https://air.unimi.it/gw/rest/api/equipments?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/equipments?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/equipments?department.idAb=123456
					
To search an Equipment witch owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/equipments?department.relation=owner&department.match=byPerson&department.id=4400
					
To search an Equipment that contains a specific user type dictionary with code userType.internal

					https://air.unimi.it/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://air.unimi.it/gw/rest/api/equipments?userType=userType.byProject&userType=userType.internal
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/equipments;full/id=12345 [collapse]

Example
   
[
{
"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\u0027ateneo"
	 }
  },
  {
	 "user":{
		"id":87564,
		"description":"Interna all\u0027ateneo"
	 }
  }
],
"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://air.unimi.it/gw/rest/api/equipments?id=12345 [collapse]

Example
   
[
{
  "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"
  }
}
]
							
Back to summary

/gw/rest/api/spinoffs

Methods

GET 

/gw/rest/api/spinoffs

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values. For example https://air.unimi.it/gw/rest/api/spinoffs?type=2018&year=2019
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

[year]

number

Item create year

[wfState]

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This parameter allows to specify the relation of ther person with this item. Only owner|contributor values are allowed. This field must be used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

userType

string

This parameter allows to specify the userType dictionary. If specified, the items that contain the specified dictionary with the specific code are returned. It's possible to specify more than one value, in which case will be returned all the items that contain at least one of them. To see all the codes linked to the dictionaries, search "RM - ATTREZZATURE - UTENZA" in the application page that manage all the dictionaries See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/spinoffs
					
To search person with CF like 123456

					https://air.unimi.it/gw/rest/api/spinoffs?person.cf=UYGUSGAUYGUGY					
					
To search person with position owner of spinoff and CF like XXXXXXX

					https://air.unimi.it/gw/rest/api/spinoffs?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/spinoffs?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/spinoffs?department.idAb=123456
					
To search an spinoff witch owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/spinoffs?department.relation=owner&department.match=byPerson&department.id=4400
					
To search an spinoff that contains a specific user type dictionary with code userType.internal

					https://air.unimi.it/gw/rest/api/spinoffs?userType=userType.internal
					
To search an spinoff that contains at least one user type dictionary with codes userType.byProject or userType.internal

					https://air.unimi.it/gw/rest/api/spinoffs?userType=userType.byProject&userType=userType.internal
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/spinoffs;full/id=12345 [collapse]

Example
   
[
{
"uid":"wfItem-17032",
"id":17032,
"discriminator":"wfItem",
"displayValue":"TEST FAST",
"year":2001,
"snapshot":false,
"lastModified":"2018-04-10T12:14:40",
"laboratoryspinoffLinkSet":[
  {
	 "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\u0027ateneo"
	 }
  },
  {
	 "user":{
		"id":87564,
		"description":"Interna all\u0027ateneo"
	 }
  }
],
"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"
	 }
  }
],
"spinoff":{
  "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://air.unimi.it/gw/rest/api/spinoffs?id=12345 [collapse]

Example
   
[
{
  "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"
  }
}
]
							
Back to summary

/gw/rest/api/products

Methods

GET 

/gw/rest/api/products

Available sort fields:dc.title_sort,datesubmission_dt,collection.name_sort,dc.date.lastModifiedDate_dt,dateIssued.year_sort

Request Query Parameters
parameter value description

author.pid

string

get publications of author identified by RPID

author.idAb

string

get publications of author identified by ID_AB (only for universities WITH U-GOV)

author.cf

string

get publications of author identified by cf

author.sourceId

string

get publications of author identified by sourceId (only for universities WITHOUT U-GOV)

selected.author.pid

string

get publication chosen as "TOP PUBLICATIONS" by author identified by RPID

submitter.pid

string

get publication by submitter identified by RPID

handle

string

get publications by specified handle

search_text

string

get publications by generic text

title

string

get publications by title

year

string

get publications by publication's year

journal.title

string

get publications by journal title

journal.pid

string

get publications by journal pid

journal.issn

string

get publications by journal issn

serie.title

string

get publications by serie title

serie.pid

string

get publications by serie pid

language

string

get publications by language (ISO format)

author.name

string

get publications by author's name

search

string

get publications by generic text

citation

string

get publications by part of citation

date.accepted

string

get publications by year in metadato dc.date.accepted

doi

string

get publications by doi

type.miur

string

get publications by miur classification

department.id

string

get publications by department id

collection

string

get publications by collection

fulltext

string

get publications by fulltext

department.idAb

string

get publications by department idAb

date.lastmodified.min

date format YYYY-MM-DDTHH:MM:SSZ

get publications from publication lastmodified date

date.lastmodified.max

date format YYYY-MM-DDTHH:MM:SSZ

get publications to publication lastmodified date

date.dclastmodified.min

date format YYYY-MM-DDTHH:MM:SSZ

get publications from metadata dc lastmodified date

date.dclastmodified.max

date format YYYY-MM-DDTHH:MM:SSZ

get publications to metadata dc lastmodified date

scopus

string

get publications by scopus eid

isi

string

get publications by wos eid

pmid

string

get publications by pubmed id

state

string

get publications by state.

To retrieve items in workspace, add parameter
&state=workspace
To retrieve items in workflow, add parameter
&state=workflow
To retrieve public item, add parameter
&state=archive

validation.relation

string

get publications by type (default mostValidated)

To retrieve master items
&validation.relation=master
To retrieve disseminated items
&validation.relation=mostValidated 
To retrieve all
&validation.relation=all
Return value definitions
fielddescription

citation

metadato citation

authors

publication's authors

dc.title

publication title

handle

publication handle

link

publication url

dateIssued

publication date

language

publication language

fulltextPresence

publication file presence

lastModified

last modified date of publication

citationCount

  • isi
  • scopus
  • pmc

citation count about isi, scopus, pmc
Attenzione: possono essere utilizzati previo rispetto delle regole imposte dagli editori per il riuso dei dati

collection

type/collection of publication

dc.subject.keywords

publication keywords

dc.identifier.doi

doi identifier of publication

journal

  • pid
  • issn
  • title

journal object of publication, with id, issn and title

serie

  • pid
  • issn
  • title

serie object of publication, with id, issn and title

ssd

settore scientifico disciplinare

descriptionAbstractAll

publication description

dateIssued.year

year of publication

search.legacyid_i

internal id

dc.date.accepted

dc.date.accepted

personId

list of author's info: lastname,firstname,mail,cf,internal id,idAb,internal pid,idCsa,orcid

stato

publication workflow state

dc.type.miur

MIUR type/collection

miur.stato

MIUR state

dc.identifier.scopus

Scopus eid

dc.identifier.isi

WOS eid

dc.identifier.pmid

PubmedId
Examples:
To get all publications

						https://air.unimi.it/gw/rest/api/products
					
To get publications whose author is identified by RP rp03683

						https://air.unimi.it/gw/rest/api/products?author.pid=rp03683
					
To get the 5 "TOP PUBLICATIONS" whose author is identified by RP rp03683

						https://air.unimi.it/gw/rest/api/products?selected.author.pid=rp03683&pageSize=5
					

available response representations:

available response representations:

  • BASE OUTPUT: [collapse]

    Example
    
    {
      "resultList": [
        {
          "search.legacyid_i": 0000000,
          "handle": "XXXX/YYYYYYYY",
          "dateIssued.year": 1998,
          "dc.date.issued_dt": "1998-11-01T00:00:00Z",
          "dc.identifier.doi": "10.1002/(SICI)1098-2299(199811/12)45:3/4<379::AID-DDR38>3.0.CO;2-Y",
          "dc.subject.keywords": "adenosine A3 receptors; astrocytes; rat; human; cell survival",
          "dc.title": "Adenosine A3 receptor and viability of astrocytes",
          "descriptionAbstractAll": "We investigated the role of the A(3) adenosine receptor in cells of the astroglial lineage (both rat primary astrocytes and human astrocytoma ADF cells) by means of the selective A(3) agonists N-6-(3-iodobenzyl)-adenosine-5'-N-methyluronamide (IB-MECA) and CI-IB-MECA, and by utilizing the selective AS receptor antagonist MRS1191. Exposure of ADF cells to mu M concentrations of either agonist resulted in reduction of cell number, likely due to cell death. In both rat astrocytes and human astrocytoma cells, at concentrations 2-3 orders of magnitude lower (which were not associated with cytotoxicity), these same agonists induced a marked reorganization of the cytoskeleton, with appearance of stress fibers and numerous cell protrusions. Functionally, these morphological changes were associated with cell protection, as demonstrated by a significant reduction of spontaneous apoptosis in A(3) agonist-treated cells. To confirm a role for the A(3) receptor in this effect, MRS1191 completely counteracted CI-IB-MECA-induced reduction of spontaneous apoptosis. In ADF cells, Ay agonists also induced changes in the intracellular distribution of the anti-apoptotic protein Bcl-X-L which became localized in cell protrusions. Also, this effect was specifically antagonized by MRS1191. These dual actions of A(3) agonists in vitro may have important in vivo implications. For example, a robust and acute activation of the A(3) receptor following massive adenosine release during ischemia may contribute to brain cell death; conversely, a subthreshold activation of this receptor prior to ischemia may trigger protective mechanisms (i.e., induction of stress fibers and of a Bcl-X-L-dependent reorganization of cytoskeleton) making the brain more resistant to subsequent insults (\"ischemic tolerance\").",
          "dc.type.miur": "262",
          "score": 5.2882724,
          "dc.identifier.scopus":"2-s2.XXXXXXXXXX", 
          "dc.identifier.isi":"WOS:XXXXXXXXX",
          "dc.identifier.pmid":"XXXXXXXXXX",
          "collection": "01 - Articolo su periodico",
          "citation": "Adenosine A3 receptor and viability of astrocytes / M.P. Abbracchio, S. Ceruti, R. Brambilla, D. Barbieri, C. Franceschi, A.M. Giammarioli, K.A. Jacobson, F. Cattabeni, W. Malorni. - In: DRUG DEVELOPMENT RESEARCH. - ISSN 0272-4391. - 45:3-4(1998 Nov), pp. 379-386. ((Intervento presentato al 6. convegno International Symposium on Adenosine and Adenine Nucleotides, New Frontiers in the 3rd-Millennium tenutosi a Ferrara nel 1998 [10.1002/(SICI)1098-2299(199811/12)45:3/4<379::AID-DDR38>3.0.CO;2-Y].",
          "authors": "M.P. Abbracchio, S.M. Ceruti, M. Paffetti, D. Barbieri, C. Franceschi, A.M. Giammarioli, K.A. Jacobson, P. Baciga, W. Malorni",
          "dateIssued": "1998-11-01T00:00:00Z",
          "language": "eng",
          "journal": {
            "pid": "journalXXXXX",
            "issn": "YYYY-XXXX",
            "title": "DRUG DEVELOPMENT RESEARCH"
          },
          "fulltextPresence": "reserved",
          "ssd": "Settore BIO/14 - Farmacologia",
          "lastModified": "2023-03-14T16:20:09Z",
          "citationCount": {
            "isi": "35",
            "scopus": "42"
          },
          "person": [
            {
              "lastname": "COGNOME",
              "firstname": "NOME",
              "mail": "nome.cognome@ateneo.it",
              "cf": "XXXXXXXXXXXXX",
              "id": "000000",
              "idAb": "TT",
              "pid": "rpXXXXX",
              "idCsa": "yyyyyy"
              "orcid": "xxxxxxxxxxxxxxxx"
            }
          ],
          "stato": "archive"
        }
      ]
    }
                                    

Back to summary

/gw/rest/api/publications --- DEPRECATO DAL 31/07/2023

Methods

GET 

/gw/rest/api/publications

Available sort fields: bi_sort_2_sort

Request Query Parameters
parameter value description

authority.people_authority

string

get publications of author identified by RPID

param.item.selected

string

get publication chosen as "TOP PUBLICATIONS" by author identified by RPID

handle

string

get publications by specified handle

Examples:
To get all publications

						https://air.unimi.it/gw/rest/api/publications
					
To get publications whose author is identified by RP rp03683

						https://air.unimi.it/gw/rest/api/publications?authority.people_authority=rp03683
					
To get the 5 "TOP PUBLICATIONS" whose author is identified by RP rp03683

						https://air.unimi.it/gw/rest/api/publications?item.selected=rp03683&pageSize=5
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
    
    {
       "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)."
          }
       ]
    }   
    
                                    

Back to summary

/gw/rest/api/projects

Methods

GET 

/gw/rest/api/projects

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values. For example https://air.unimi.it/gw/rest/api/projects?type=2018&year=2019
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[macrotype]

string

a String containing the item macro-type. Contact IRIS helpdesk for all available types

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

[call.type]

string

a String containing the linked call type. Contact IRIS helpdesk for all available types

[call.pid]

string

a String containing the linked call identifier.

[ancestorsOnly]

boolean

If true returns only projects that has NO ancestors (useful in case of project hierarchy).

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

[year]

number

Item create year

[wfState]

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This parameter allows to specify the relation of ther person with this item. Only owner|contributor values are allowed. This field must be used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/projects
					
To search person with CF like 123456

					https://air.unimi.it/gw/rest/api/projects?person.cf=UYGUSGAUYGUGY					
					
To search person with position owner of project and CF like XXXXXXX

					https://air.unimi.it/gw/rest/api/projects?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/projects?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/projects?department.idAb=123456
					
To search an project witch owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/projects?department.relation=owner&department.match=byPerson&department.id=4400
					
Back to summary

/gw/rest/api/contracts

Methods

GET 

/gw/rest/api/contracts

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values. For example https://air.unimi.it/gw/rest/api/contracts?type=2018&year=2019
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[macrotype]

string

a String containing the item macro-type. Contact IRIS helpdesk for all available types

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

[year]

number

Item create year

[wfState]

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This parameter allows to specify the relation of ther person with this item. Only owner|contributor values are allowed. This field must be used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/contracts
					
To search person with CF like 123456

					https://air.unimi.it/gw/rest/api/contracts?person.cf=UYGUSGAUYGUGY					
					
To search person with position owner of contract and CF like XXXXXXX

					https://air.unimi.it/gw/rest/api/contracts?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/contracts?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/contracts?department.idAb=123456
					
To search an contract witch owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/contracts?department.relation=owner&department.match=byPerson&department.id=4400
					
Back to summary

/gw/rest/api/calls

Methods

GET 

/gw/rest/api/calls

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values. For example https://air.unimi.it/gw/rest/api/calls?type=2018&year=2019
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

[year]

number

Item create year

[wfState]

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This parameter allows to specify the relation of ther person with this item. Only owner|contributor values are allowed. This field must be used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/calls
					
To search person with CF like 123456

					https://air.unimi.it/gw/rest/api/calls?person.cf=UYGUSGAUYGUGY					
					
To search person with position owner of call and CF like XXXXXXX

					https://air.unimi.it/gw/rest/api/calls?person.relation=onwer&person.cf=UYGUSGAUYGUGY					
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/calls?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/calls?department.idAb=123456
					
To search an call witch owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/calls?department.relation=owner&department.match=byPerson&department.id=4400
					
Back to summary

/gw/rest/api/external-organizations

Methods

GET 

/gw/rest/api/external-organizations

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*idAb

string

a String containing the idAb number of the item given by U-GOV. See response for values

*miurIdentifier

string

a String containing the miurIdentifier of the item given by loginmiur. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/external-organizations
					
To search Item with ID 123456

					https://air.unimi.it/gw/rest/api/external-organizations?id=123456
					
To search Item with idAb 123456

					https://air.unimi.it/gw/rest/api/external-organizations?idAb=123456
					
To search Item with miurIdentifier 123456

					https://air.unimi.it/gw/rest/api/external-organizations?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/external-organizations?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":1857,
          "displayValue":"EX-DIPARTIMENTO DI NEUROSCIENZE E TECNOLOGIE BIOMEDICHE-(1998/2012)",
          "sourceId":"1174",
          "idAb":"100140"
       }
    ]
                                    

Back to summary

/gw/rest/api/faculties

Methods

GET 

/gw/rest/api/faculties

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

idAb

string

a String containing the idAb number of the item given by U-GOV. See response for values

sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/faculties
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/faculties?id=123456
					
To search Item with idAb like 123456

					https://air.unimi.it/gw/rest/api/faculties?idAb=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/faculties?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":1614,
          "displayValue":"ex-FACOLTA\u0027 DI SCIENZE STATISTICHE",
          "sourceId":"1074",
          "idAb":"100128"
       }
    ]
                                    

Back to summary

/gw/rest/api/incoming-people

Methods

GET 

/gw/rest/api/incoming-people

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

incoming|tutor

This field select a specific relation for a person. This field is used in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/incoming-people
					
To search Item with CF like 123456

					https://air.unimi.it/gw/rest/api/incoming-people?person.cf=UYGUSGAUYGUGY
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/incoming-people?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/incoming-people?department.idAb=123456
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/incoming-people;full/id=12345 [collapse]

Example
   
{
   "uid":"wfItem-16514",
   "id":16514,
   "discriminator":"wfItem",
   "displayValue":"Detection and analysis of hidden temporal patterns in behaviour using Theme.  New concepts in the T-pattern detection analysis.  Overview of recent research involving Theme.  Open-Source tool developments in methodology.  Working on new journal",
   "year":2017,
   "snapshot":false,
   "lastModified":"2018-03-05T14:12:41",
   "tutorSet":[
      {
         "endDate":"2017-04-27T00:00:00",
         "startDate":"2017-04-23T00:00:00",
         "person":{
            "idAb":"106063",
            "cf":"ZRLXXXXXXXXXX5Z",
            "id":72,
            "ORCID":"0000-0002-4469-402X",
            "firstName":"VATINO",
            "pid":"rp00560",
            "lastName":"ZUNI"
         }
      }
   ],
   "wfItemType":{
      "parentWfItemTypeSet":{
         "description":"Mobilità in ingresso",
         "identifier":"INM"
      },
      "identifier":"INM.ERASMUS-PROFESSOR",
      "code":"INM",
      "description":"Erasmus Professor"
   },
   "mainInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "description":"DIPARTIMENTO DI SCIENZE UMANE PER LA FORMAZIONE \"RICCARDO MASSA\"",
            "id":4412
         }
      }
   ],
   "identifier":"INM-0111",
   "department":{
      "id":4412,
      "sourceId":"2962",
      "description":"DIPARTIMENTO DI SCIENZE UMANE PER LA FORMAZIONE \"RICCARDO MASSA\"",
      "idAb":"110428"
   },
   "startDate":"2017-04-23T00:00:00",
   "wfState":{
      "id":678,
      "description":"validated"
   },
   "miurExternalOrganizationSet":[
      {
         "externalOrganization":{
            "id":56688,
            "miurIdentifier":"13215",
            "description":"University of Iceland"
         }
      }
   ],
   "academicArea":{
      "id":1664,
      "description":"11 - Scienze storiche, filosofiche, pedagogiche e psicologiche",
      "sourceId":"11",
      "code":"11"
   },
   "owner":{
      "pid":"rp16801",
      "lastName":"Jonn",
      "firstName":"Gurg",
      "id":22752
   },
   "endDate":"2017-04-27T00:00:00",
   "incomingType":{
      "id":87562,
      "description":"didattica e ricerca"
   },
   "secondaryInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":4412,
            "description":"DIPARTIMENTO DI SCIENZE UMANE PER LA FORMAZIONE \"RICCARDO MASSA\""
         }
      }
   ],
   "dateDifference":5,
   "description":"Detection and analysis of hidden temporal patterns in behaviour using Theme.  New concepts in the T-pattern detection analysis.  Overview of recent research involving Theme.  Open-Source tool developments in methodology.  Working on new journal"
}
							
BASE OUTPUT: https://air.unimi.it/gw/rest/api/incoming-people?id=12345 [collapse]

Example
   
{
   "id":16514,
   "displayValue":"Detection and analysis of hidden temporal patterns in behaviour using Theme.  New concepts in the T-pattern detection analysis.  Overview of recent research involving Theme.  Open-Source tool developments in methodology.  Working on new journal",
   "year":2017,
   "tutorSet":[
      {
         "endDate":"2017-04-27T00:00:00",
         "person":{
            "ORCID":"1230-0002-4469-4023X",
            "firstName":"NTINO",
            "idAb":"106063",
            "cf":"ZRLXXXXXXXXXX5Z",
            "pid":"rp00560",
            "lastName":"ZNI",
            "id":72
         },
         "startDate":"2017-04-23T00:00:00"
      }
   ],
   "department":{
      "sourceId":"2962",
      "description":"DIPARTIMENTO DI SCIENZE UMANE PER LA FORMAZIONE \"RICCARDO MASSA\"",
      "id":4412,
      "idAb":"110428"
   },
   "wfState":{
      "id":678,
      "description":"validated"
   }
}

							
Back to summary

/gw/rest/api/internal-organizations

Methods

GET 

/gw/rest/api/internal-organizations

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

type

string

a String containing the type of the item. See response for values

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*idAb

string

a String containing the idAb number of the item given by U-GOV. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

name

string

a String containing the description of the item. "*" character can be used. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/internal-organizations
					
To search Item with ID 123456

					https://air.unimi.it/gw/rest/api/internal-organizations?id=123456
					
To search Item with idAb 123456

					https://air.unimi.it/gw/rest/api/internal-organizations?idAb=123456
					
To search Item with miurIdentifier 123456

					https://air.unimi.it/gw/rest/api/internal-organizations?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/internal-organizations?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    [
       {
          "id":1857,
          "displayValue":"EX-DIPARTIMENTO DI NEUROSCIENZE E TECNOLOGIE BIOMEDICHE-(1998/2012)",
          "sourceId":"1174",
          "idAb":"100140"
       }
    ]
                                    

Back to summary

/gw/rest/api/journals

Methods

GET 

/gw/rest/api/journals

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*code

string

a String containing the code of the item. See response for values

*issn

string

a String containing the ISSN of the item. See response for values

nature

string

a String containing the nature code of the item. See response for values

country

string

a String containing the country code of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/journals
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/journals?id=123456
					
To search Item with idAb like 123456

					https://air.unimi.it/gw/rest/api/journals?idAb=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/journals?name=Scienze
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/journals/id=12345 [collapse]

    Example
       
    {
       "id":54,
       "displayValue":"ENCYCLOPAIDEIA",
       "country":"IT",
       "nature":"R",
       "publisher":"Dal 1999 l\u0027editore è :\nBologna: CLUEB Editrice. \n\nPrecedente:\n Il Segnalibro (Torino)",
       "code":"E187971",
       "issn":"1590-492X"
    }
                                    

  • FULL OUTPUT: https://air.unimi.it/gw/rest/api/journals;full/id=12345 [collapse]

    Example
       
    {
       "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\u0027editore è :\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"
    }
    
                                    

Back to summary

/gw/rest/api/laboratories

Methods

GET 

/gw/rest/api/laboratories

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator.The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/laboratories
					
To search Item with CF like 123456

					https://air.unimi.it/gw/rest/api/laboratories?person.cf=UYGUSGAUYGUGY
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/laboratories?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/laboratories?department.idAb=123456
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/laboratories;full/id=12345 [collapse]

Example
   
{
   "uid":"wfItem-16712",
   "id":16712,
   "discriminator":"wfItem",
   "displayValue":"laboratorio ricerca e servizi",
   "year":2018,
   "snapshot":false,
   "lastModified":"2018-01-31T15:10:06",
   "wfItemType":{
      "parentWfItemTypeSet":{
         "description":"Laboratori",
         "identifier":"LAB"
      },
      "identifier":"LAB.RIC-SER",
      "code":"LAB",
      "description":"Laboratorio di ricerca e servizi"
   },
   "internalRepresentativeSet":[
      {
         "person":{
            "id":4769,
            "pid":"rp05578",
            "cf":"RGXXXXXXX88A",
            "lastName":"AsdfsdfON",
            "firstName":"LsdfGO",
            "idAb":"141679"
         }
      }
   ],
   "ownerSet":[
      {
         "person":{
            "idAb":"104953",
            "id":931,
            "firstName":"GIdsffO",
            "cf":"NNNGRXXXXXXXXXXC",
            "ORCID":"0000-0002-7312-136X",
            "lastName":"sfsdfsdfNI",
            "pid":"rp01253"
         }
      }
   ],
   "internalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":30955,
            "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)",
            "sourceId":"3499",
            "idAb":"112929"
         }
      }
   ],
   "identifier":"LAB-0001",
   "startDate":"2018-01-03T00:00:00",
   "wfState":{
      "id":655,
      "description":"approved"
   },
   "collocation":"U16",
   "visibleOnPortal":true,
   "abstract":"AAA"
   "description":"laboratorio ricerca e servizi",
   "ownerPersonCurrentOrLastInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":30955,
            "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
         }
      }
   ]
}
							
BASE OUTPUT: https://air.unimi.it/gw/rest/api/laboratories?id=12345 [collapse]

Example
   
{
   "id":16712,
   "displayValue":"laboratorio ricerca e servizi",
   "year":2018,
   "ownerSet":[
      {
         "person":{
            "firstName":"RGIO",
            "idAb":"104953",
            "id":931,
            "pid":"rp01253",
            "cf":"NNN2F20XXXXXXX5C",
            "ORCID":"0000-0002-7312-136X",
            "lastName":"ANdf"
         }
      }
   ],
   "ownerPersonCurrentOrLastInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":30955,
            "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
         }
      }
   ],
   "wfState":{
      "id":655,
      "description":"approved"
   }
}

							
Back to summary

/gw/rest/api/libraries

Methods

GET 

/gw/rest/api/libraries

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*idAb

string

a String containing the idAb number of the item given by U-GOV. See response for values

*sourceId

string

a String containing the sourceId of the item given by third parties application. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/libraries
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/libraries?id=123456
					
To search Item with idAb like 123456

					https://air.unimi.it/gw/rest/api/libraries?idAb=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/libraries?name=Scienze
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/libraries/id=12345 [collapse]

    Example
       
    {
       "id":1727,
       "displayValue":"ex-BIBLIOTECA CENTRALE",
       "sourceId":"1112",
       "idAb":"112079"
    }
                                    

  • FULL OUTPUT: https://air.unimi.it/gw/rest/api/libraries;full/id=12345 [collapse]

    Example
       
    {
       "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"
    }
    
                                    

Back to summary

/gw/rest/api/people

Methods

GET 

/gw/rest/api/people

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, lastModified
WARNING: The awarder attribute for prize elements will be soon removed from full version of this service.
This piece of info can be retrieved by using /gw/rest/api/prizes service.

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

*pid

string

a String containing the Person PID (IRIS IR). See response for values

*idAb

string

a String containing the Person idAb. See response for values

*cf

string

a String containing the Person CF (Codice Fiscale). See response for values

*sourceId

string

a String containing the Person sourceId of the item given by third parties Application. The search have place in all fields that afferis into this type of item. See response for values

*orcid

string

a String containing the Person ORCID. See response for values

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

role.id

string

a String containing the role id. See response for values

role.code

string

a String containing the role code (U-GOV). See response for values

role.sourceId

string

a String containing the role sourceId (non U-GOV instances). See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/people
					
To search Item with CF like 123456

					https://air.unimi.it/gw/rest/api/people?cf=UYGUSGAUYGUGY
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/people?idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/people?department.idAb=123456
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/people;full/id=12345 [collapse]

Example
   
{
   "uid":"person-3",
   "id":3,
   "discriminator":"person",
   "displayValue":"asd qwe 123",
   "lastModified":"2017-08-31T06:21:48",
   "priorityLastPosition":{
      "phdCourse":{
         "positionType":{
            "description":"DOTTORANDO",
            "discriminator":"research",
            "id":"8330"
         },
         "description":"MEDICINA TRASLAZIONALE E MOLECOLARE (DIMET) - 45R",
         "id":4547,
         "sourceId":"45R"
      },
      "identificationNumber":{
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":"2736",
            "discriminator":"support"
         },
         "id":3736,
         "description":"2320"
      },
      "department":{
         "sourceId":"3499",
         "positionType":{
            "discriminator":"support",
            "id":"2736",
            "description":"Non Docente di ruolo"
         },
         "id":30955,
         "idAb":"112929",
         "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
      },
      "supportTitle":{
         "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati",
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":"2736",
            "discriminator":"support"
         },
         "id":7613
      },
      "researchTitle":{
         "id":23881,
         "positionType":{
            "description":"DOTTORANDO",
            "id":"8330",
            "discriminator":"research"
         },
         "description":"DOTTORANDO"
      }
   },
   "priorityCurrentPosition":{
      "identificationNumber":{
         "positionType":{
            "id":"2736",
            "description":"Non Docente di ruolo",
            "discriminator":"support"
         },
         "id":3736,
         "description":"2320"
      },
      "department":{
         "sourceId":"3499",
         "positionType":{
            "id":"2736",
            "description":"Non Docente di ruolo",
            "discriminator":"support"
         },
         "id":30955,
         "idAb":"112929",
         "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
      },
      "supportTitle":{
         "positionType":{
            "id":"2736",
            "discriminator":"support",
            "description":"Non Docente di ruolo"
         },
         "id":7613,
         "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati"
      }
   },
   "codiceFiscaleSet":[
      {
         "startDate":"1998-06-10T00:00:00",
         "description":"XXXXXXXXXXXXXXXXX"
      }
   ],
   "positionCurrentSet":[
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"supportTitle"
            },
            "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati",
            "id":7613
         },
         "discriminator":"support",
         "id":19126302,
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":2736
         },
         "startDate":"2015-10-01T00:00:00",
         "endDate":"2222-02-01T00:00:00",
         "priority":70
      },
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"identificationNumber"
            },
            "description":"2320",
            "id":3736
         },
         "discriminator":"support",
         "id":19100070,
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":2736
         },
         "startDate":"2015-10-01T00:00:00",
         "endDate":"2222-02-01T00:00:00",
         "priority":70
      },
      {
         "organizationUnit":{
            "sourceId":"3499",
            "organizationUnitType":{
               "description":"department"
            },
            "idAb":"112929",
            "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)",
            "id":30955
         },
         "discriminator":"support",
         "id":19134506,
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":2736
         },
         "startDate":"2015-10-01T00:00:00",
         "endDate":"2222-02-01T00:00:00",
         "priority":70
      }
   ],
   "positionLastSet":[
      {
         "organizationUnit":{
            "sourceId":"1100",
            "organizationUnitType":{
               "description":"department"
            },
            "id":1692,
            "description":"EX-DIPARTIMENTO DI BIOTECNOLOGIE E BIOSCIENZE-(1998/2012)",
            "idAb":"100130"
         },
         "startDate":"2004-12-16T00:00:00",
         "discriminator":"research",
         "positionType":{
            "id":8330,
            "description":"DOTTORANDO"
         },
         "priority":0,
         "id":19068955,
         "endDate":"2007-11-27T00:00:00"
      },
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"identificationNumber"
            },
            "id":19080,
            "description":"R00621"
         },
         "startDate":"2004-12-16T00:00:00",
         "discriminator":"research",
         "positionType":{
            "id":8330,
            "description":"DOTTORANDO"
         },
         "priority":0,
         "id":19077357,
         "endDate":"2007-11-27T00:00:00"
      },
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"researchTitle"
            },
            "id":23881,
            "description":"DOTTORANDO"
         },
         "startDate":"2004-12-16T00:00:00",
         "discriminator":"research",
         "positionType":{
            "id":8330,
            "description":"DOTTORANDO"
         },
         "priority":0,
         "id":19077947,
         "endDate":"2007-11-27T00:00:00"
      },
      {
         "organizationUnit":{
            "sourceId":"45R",
            "organizationUnitType":{
               "description":"phdCourse"
            },
            "id":4547,
            "description":"MEDICINA TRASLAZIONALE E MOLECOLARE (DIMET) - 45R"
         },
         "startDate":"2004-12-16T00:00:00",
         "discriminator":"research",
         "positionType":{
            "id":8330,
            "description":"DOTTORANDO"
         },
         "priority":0,
         "id":19073757,
         "endDate":"2007-11-27T00:00:00"
      },
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"supportTitle"
            },
            "id":7613,
            "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati"
         },
         "startDate":"2015-10-01T00:00:00",
         "discriminator":"support",
         "positionType":{
            "id":2736,
            "description":"Non Docente di ruolo"
         },
         "priority":70,
         "id":19126302,
         "endDate":"2222-02-01T00:00:00"
      },
      {
         "organizationUnit":{
            "sourceId":"3499",
            "organizationUnitType":{
               "description":"department"
            },
            "id":30955,
            "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)",
            "idAb":"112929"
         },
         "startDate":"2015-10-01T00:00:00",
         "discriminator":"support",
         "positionType":{
            "id":2736,
            "description":"Non Docente di ruolo"
         },
         "priority":70,
         "id":19134506,
         "endDate":"2222-02-01T00:00:00"
      },
      {
         "organizationUnit":{
            "organizationUnitType":{
               "description":"identificationNumber"
            },
            "id":3736,
            "description":"2320"
         },
         "startDate":"2015-10-01T00:00:00",
         "discriminator":"support",
         "positionType":{
            "id":2736,
            "description":"Non Docente di ruolo"
         },
         "priority":70,
         "id":19100070,
         "endDate":"2222-02-01T00:00:00"
      }
   ],
   "gender":{
      "id":20242,
      "description":"Femminile"
   },
   "cf":"XXXXXXXXXXXXXXXXX",
   "contactSet":[
      {
         "principal":true,
         "description":"asd.qwe@universita.it",
         "type":"mail"
      }
   ],
   "idAb":"111748",
   "pid":"rp00491",
   "lastName":"asd qwe",
   "firstName":"123",
   "birthDate":"1973-12-19T00:00:00"
}
							
BASE OUTPUT: https://air.unimi.it/gw/rest/api/people?id=12345 [collapse]

Example
   
{
   "id":3,
   "priorityLastPosition":{
      "phdCourse":{
         "positionType":{
            "description":"DOTTORANDO",
            "discriminator":"research",
            "id":"8330"
         },
         "sourceId":"45R",
         "description":"MEDICINA TRASLAZIONALE E MOLECOLARE (DIMET) - 45R",
         "id":4547
      },
      "identificationNumber":{
         "id":3736,
         "description":"2320",
         "positionType":{
            "description":"Non Docente di ruolo",
            "discriminator":"support",
            "id":"2736"
         }
      },
      "department":{
         "positionType":{
            "id":"2736",
            "description":"Non Docente di ruolo",
            "discriminator":"support"
         },
         "id":30955,
         "idAb":"112929",
         "sourceId":"3499",
         "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
      },
      "researchTitle":{
         "positionType":{
            "description":"DOTTORANDO",
            "id":"8330",
            "discriminator":"research"
         },
         "description":"DOTTORANDO",
         "id":23881
      },
      "supportTitle":{
         "positionType":{
            "description":"Non Docente di ruolo",
            "id":"2736",
            "discriminator":"support"
         },
         "id":7613,
         "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati"
      }
   },
   "priorityCurrentPosition":{
      "department":{
         "positionType":{
            "description":"Non Docente di ruolo",
            "discriminator":"support",
            "id":"2736"
         },
         "sourceId":"3499",
         "id":30955,
         "idAb":"112929",
         "description":"DIPARTIMENTO DI MEDICINA E CHIRURGIA (SCHOOL OF MEDICINE AND SURGERY)"
      },
      "supportTitle":{
         "id":7613,
         "positionType":{
            "discriminator":"support",
            "description":"Non Docente di ruolo",
            "id":"2736"
         },
         "description":"Categoria C - Area tecnica, tecnico-scientifica ed elaborazione dati"
      },
      "identificationNumber":{
         "positionType":{
            "id":"2736",
            "description":"Non Docente di ruolo",
            "discriminator":"support"
         },
         "id":3736,
         "description":"2320"
      }
   },
   "pid":"rp00491",
   "lastName":"asd qwe",
   "cf":"XXXXXXXXXXXXXXXXX",
   "idAb":"111748",
   "firstName":"123"
}
							
Back to summary

/gw/rest/api/person-roles

Methods

GET 

/gw/rest/api/person-roles

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

*code

string

a String containing the code of the item given by U-GOV. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/person-roles
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/person-roles?id=123456
					
To search Item with code like 123456

					https://air.unimi.it/gw/rest/api/person-roles?code=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/person-roles?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    {
       "id":23462,
       "displayValue":"DIRETTORE DI ISTITUTO"
    }
                                    

Back to summary

/gw/rest/api/person-titles

Methods

GET 

/gw/rest/api/person-titles

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, startDate, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

*code

string

a String containing the code number of the item given by U-GOV. See response for values

*sourceId

string

a String containing the sourceId of the item in source Applications (for universities not using U-GOV)

position.match

current|notCurrent|all

a String containing "current", "notCurrent" or "all". Return the items that are current (active), not current (not active) or all the elements. If not specified it defaults to all. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/person-titles
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/person-titles?id=123456
					
To search Item with code like 123456

					https://air.unimi.it/gw/rest/api/person-titles?code=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/person-titles?name=Scienze
					

available response representations:

  • BASE OUTPUT: [collapse]

    Example
       
    {
       "id":5480,
       "displayValue":"Ricercatore a contratto a tempo determinato"
    }
                                    

Back to summary

/gw/rest/api/prizes

Methods

GET 

/gw/rest/api/prizes

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, lastModified

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

*miurIdentifier

string

a String containing the miurIdentifier number of the item given by MIUR. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/prizes
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/prizes?id=123456
					
To search Item with miurIdentifier like 123456

					https://air.unimi.it/gw/rest/api/prizes?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/prizes?name=Scienze
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/prizes/id=12345 [collapse]

    Example
       
    {
       "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://air.unimi.it/gw/rest/api/prizes;full/id=12345 [collapse]

    Example
       
    {
       "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"
    }
    
                                    
Back to summary

/gw/rest/api/public-engagements

Methods

GET 

/gw/rest/api/public-engagements

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/public-engagements
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/public-engagements?id=123456
					
To search Item with miurIdentifier like 123456

					https://air.unimi.it/gw/rest/api/public-engagements?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/public-engagements?name=Scienze
					
To search a public-engagements on witch its owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/public-engagements?department.relation=owner&department.match=byPerson&department.id=4400
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/public-engagements/id=12345 [collapse]

    Example
       
    {
       "id":17031,
       "displayValue":"test terza missione arcelli nuova",
       "year":2018,
       "ownerSet":[
          {
             "person":{
                "idAb":"105031",
                "id":505,
                "pid":"rp00180",
                "firstName":"FRANCESCA",
                "cf":"RCLFNC61M60G535N",
                "ORCID":"0000-0002-1195-530X",
                "lastName":"ARCELLI FONTANA"
             },
             "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://air.unimi.it/gw/rest/api/public-engagements;full/id=12345 [collapse]

    Example
       
    {
       "uid":"wfItem-17031",
       "id":17031,
       "discriminator":"wfItem",
       "displayValue":"test terza missione arcelli nuova",
       "year":2018,
       "snapshot":false,
       "lastModified":"2018-04-11T17:39:16",
       "estimatedImpact":"asdasdsadsad",
       "contributorSet":[
          {
             "person":{
                "pid":"rp05200",
                "id":5526,
                "lastName":"ABATE",
                "idAb":"127652",
                "cf":"BTAMGL77C66A509M",
                "firstName":"MARIA GIULIA"
             },
             "role":{
                "description":"Discussant",
                "id":87546
             }
          }
       ],
       "ownerSet":[
          {
             "person":{
                "idAb":"105031",
                "id":505,
                "firstName":"FRANCESCA",
                "cf":"RCLFNC61M60G535N",
                "pid":"rp00180",
                "ORCID":"0000-0002-1195-530X",
                "lastName":"ARCELLI FONTANA"
             },
             "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 arcelli nuova",
                "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":1.23123123E8,
       "numTotalDay":1.0,
       "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":1.23123231E8,
       "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
    }
    
                                    

Back to summary

/gw/rest/api/research-centres

Methods

GET 

/gw/rest/api/research-centres

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/research-centres
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/research-centres?id=123456
					
To search Item with miurIdentifier like 123456

					https://air.unimi.it/gw/rest/api/research-centres?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/research-centres?name=Scienze
					
To search a research-centres on witch its owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/research-centres?department.relation=owner&department.match=byPerson&department.id=4400
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/research-centres/id=12345 [collapse]

    Example
    
    {
      "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://air.unimi.it/gw/rest/api/research-;full/id=12345 [collapse]

    Example
    
    {
      "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": "researchCentreInternalOrganizationUnitRole.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": "researchCentreInternalOrganizationUnitRole.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 ..."
    }
                                    

Back to summary

/gw/rest/api/continuous-trainings

Methods

GET 

/gw/rest/api/continuous-trainings

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/continuous-trainings
					
To search Item with ID like 123456

					https://air.unimi.it/gw/rest/api/continuous-trainings?id=123456
					
To search Item with miurIdentifier like 123456

					https://air.unimi.it/gw/rest/api/continuous-trainings?miurIdentifier=123456
					
To search Item with name like Scienze:

					https://air.unimi.it/gw/rest/api/continuous-trainings?name=Scienze
					
To search a continuous-trainings on witch its owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/continuous-trainings?department.relation=owner&department.match=byPerson&department.id=4400
					

available response representations:

  • BASE OUTPUT: https://air.unimi.it/gw/rest/api/continuous-trainings/id=12345 [collapse]

    Example
       
    {
    	"id":230,
    	"pid":"FCO-0031",
    	"displayValue":"Prova Formazione Continua",
    	"year":2020,
    	"snapshot":false,
    	"mostValidated":true,
    	"wfState":{
    			"id":281,
    			"description":"draft"
    		},
    	"wfItemType":{
    		"identifier":"FCO.FCO",
    		"description":"Formazione Continua",
    		"parentWfItemTypeSet":
    			[{
    				"identifier":"FCO",
    				"managedBy":"user",
    				"code":"FCO",
    				"priority":13,
    				"description":"Formazione Continua"
    			}],
    		"priority":1,
    		"code":"FCO",
    		"managedBy":"user"},
    	"ownerSet":
    		[{	
    			"person":{
    			"lastName":"Mollaretti",
    			"firstName":"Andrea",
    			"pid":"rp00052",
    			"id":123}
    		}],
    	"ownerPersonCurrentOrLastInternalOrganizationUnitSet":
    		[{
    			"organizationUnit":{
    				"id":781,
    				"description":"DIPARTIMENTO DELLE LINGUE ESTERE"}
    				}]
    }
    
                                    

  • FULL OUTPUT: https://air.unimi.it/gw/rest/api/continuous-trainings;full/id=12345 [collapse]

    Example
       
    {
    	"uid":"wfItem-230",
    	"id":230,
    	"pid":"FCO-0031",
    	"discriminator":"wfItem",
    	"displayValue":"Prova Formazione Continua",
    	"year":2020,
    	"snapshot":false,
    	"mostValidated":true,
    	"lastModified":"2020-04-09T18:35:25",
    	"internalOrganizationUnitSet":
    		[
    			{
    				"role":{"id":0},
    				"organizationUnit":{
    					"id":782,
    					"description":"DIPARTIMENTO VETERINARIA"}},
    			{
    				"role":{"id":0},
    				"organizationUnit":{
    					"id":760,"description":"DIPARTIMENTO DI INFORMATICA"}},
    			{
    				"role":{
    					"description":"Organizzatore",
    					"id":14566,
    					"code":"ouRoleContinuousTraining.organizator"},
    				"organizationUnit":{
    					"id":781,"description":"DIPARTIMENTO DELLE LINGUE ESTERE"}}
    		],
    	"creator": {
    		"id":1,"lastName":"Cineca","firstName":"Administrator","pid":"rp00001"},
    	"externalOrganizationSet":
    		[
    			{
    				"role":{
    					"id":14565,
    					"description":"Coordinatore",
    					"code":"ouRoleContinuousTraining.coordinator"},
    				"organizationUnit":
    					{"description":"UNIVERSITA\u0027 DEGLI STUDI DI MILANO","id":763}}
    		],
    	"wfItemType":{
    			"identifier":"FCO.FCO",
    			"description":"Formazione Continua",
    			"parentWfItemTypeSet":
    			[{
    				"managedBy":"user",
    				"description":"Formazione Continua",
    				"identifier":"FCO",
    				"priority":13,
    				"code":"FCO"}],
    			"managedBy":"user",
    			"priority":1,
    			"code":"FCO"},
    	"wfState":{
    		"description":"draft",
    		"id":281},
    	"ownerSet":
    		[{
    			"person":{
    				"lastName":"Mollaretti",
    				"firstName":"Andrea",
    				"id":123,
    				"pid":"rp00052"}
    		}],
    	"ownerPersonCurrentOrLastInternalOrganizationUnitSet":
    		[{
    			"organizationUnit":{
    				"id":781,"description":"DIPARTIMENTO DELLE LINGUE ESTERE"}
    		}],
    	"numberOfThirdSector":5,
    	"description":"Prova Formazione Continua",
    	"otherFinancing":5.0,
    	"contributorPersonCurrentOrLastInternalOrganizationUnitSet":
    		[{
    			"organizationUnit":{
    				"id":782,"description":"DIPARTIMENTO VETERINARIA"}
    		}],
    	"startDate":"2020-04-05T00:00:00",
    	"receivedFinancing":5.0,
    	"refresherCourseForSchoolTeacher":true,
    	"percentageOfEUFinacing":10.0,
    	"contributorSet":
    		[{
    			"person":{
    			"id":124,"lastName":"Veneziani","pid":"rp00054","firstName":"Elisa"}
    		}],
    	"totalSubscriptionFees":5.0,
    	"percentageOfNationalFinacing":10.0,
    	"totalNumberOfParticipants":5010,
    	"onlineTrainingMoreThan75Percent":false,
    	"numberOfInternalTeachers":2,
    	"totalIncome":15.0,
    	"identifier":"FCO-0031",
    	"abstract":"Lunga descrizione",
    	"numberOfPublicInstitutions":5000,
    	"numberOfCompanies":5,
    	"numberOfCredits":500,
    	"paidCourse":true
    }
    
                                    

Back to summary

/gw/rest/api/workgroups

Methods

GET 

/gw/rest/api/workgroups

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*id

string

a String containing the ID of the item. See response for values

*pid

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/workgroups
					
To search Item with CF like 123456

					https://air.unimi.it/gw/rest/api/workgroups?person.cf=UYGUSGAUYGUGY
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/workgroups?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/workgroups?department.idAb=123456
					
To search a workgroups on witch its owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/workgroups?department.relation=owner&department.match=byPerson&department.id=4400
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/workgroups;full/id=12345 [collapse]

Example
   
{
   "uid":"wfItem-16755",
   "id":16755,
   "discriminator":"wfItem",
   "displayValue":"FGDGD",
   "year":2017,
   "snapshot":false,
   "lastModified":"2018-04-12T11:13:53",
   "librarySet":[
      {
         "library":{
            "idAb":"112079",
            "sourceId":"1112",
            "description":"ex-BIBLIOTECA CENTRALE",
            "id":1727
         }
      }
   ],
   "workgroupEquipmentLinkSet":[
      {
         "parent":{
            "description":"FGDGD",
            "id":16755
         },
         "child":{
            "description":"TAMBUROpROVA",
            "id":16711
         }
      }
   ],
   "contributorSet":[
      {
         "person":{
            "pid":"rp01614",
            "id":1292,
            "lastName":"GINO",
            "idAb":"135386",
            "cf":"XXXXXXXXXXXXXXXX",
            "firstName":"HEND"
         },
         "startingDate":"2018-04-01T00:00:00"
      }
   ],
   "workgroupLaboratoryLinkSet":[
      {
         "child":{
            "id":16710,
            "description":"laboratorio ricerca e servizi"
         },
         "parent":{
            "id":16755,
            "description":"FGDGD"
         }
      }
   ],
   "ownerSet":[
      {
         "person":{
            "idAb":"107034",
            "id":2480,
            "firstName":"BIGIO",
            "cf":"XXXXXXXXXXXXXXXX",
            "pid":"rp02161",
            "ORCID":"0000-0003-1480-335X",
            "lastName":"CIAO"
         }
      }
   ],
   "internalRepresentativeSet":[
      {
         "person":{
            "id":12704,
            "cf":"XXXXXXXXXXXXXXXX",
            "firstName":"ARIA",
            "idAb":"144856",
            "pid":"rp09904",
            "lastName":"STARK"
         }
      }
   ],
   "keywordErcSet":[
      {
         "keyword":{
            "code":"LS7_3",
            "description":"LS7_3 - Pharmacology, pharmacogenomics, drug discovery and design, drug therapy",
            "id":27440
         }
      }
   ],
   "externalContributors":"dasdsa asdsadsad",
   "wfItemType":{
      "parentWfItemTypeSet":{
         "identifier":"WKG",
         "description":"Gruppi di ricerca"
      },
      "identifier":"WKG.COO",
      "code":"WKG",
      "description":"Gruppo di ricerca coordinata"
   },
   "internalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":4407,
            "sourceId":"2957",
            "idAb":"110433",
            "description":"DIPARTIMENTO DI SCIENZE ECONOMICO-AZIENDALI E DIRITTO PER L\u0027ECONOMIA"
         }
      }
   ],
   "addressSet":[
      {
         "description":"qwewqewqewqeqwewqe",
         "mainAddress":false
      }
   ],
   "identifier":"WKG-0006",
   "SSDSet":[
      {
         "academicField2000":{
            "id":8180,
            "code":"AGR/01",
            "sourceId":"AGR/01",
            "description":"AGR/01 - ECONOMIA ED ESTIMO RURALE"
         }
      }
   ],
   "wfState":{
      "id":666,
      "description":"draft"
   },
   "contributorPersonCurrentOrLastInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "description":"EX-DIPARTIMENTO DI CHIRURGIA E MEDICINA TRASLAZIONALE-(2013/2015)",
            "id":24902
         }
      }
   ],
   "workgroupMiurPrizeSet":[
      {
         "prize":{
            "description":"test cineca",
            "id":444
         }
      }
   ],
   "workgroupProjectLinkSet":[
      {
         "child":{
            "id":2337,
            "description":"DC Strategies-Immunological mechanism of T cell activation by dendritic cells: a novel strategy for immune intervention"
         },
         "parent":{
            "description":"FGDGD",
            "id":16755
         }
      }
   ],
   "keywordUserDefinedSet":[
      {
         "keyword":{
            "description":"ARTRITE REUMATOIDE BOLLOSA",
            "id":24186
         }
      }
   ],
   "ownerPersonCurrentOrLastInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":4407,
            "description":"DIPARTIMENTO DI SCIENZE ECONOMICO-AZIENDALI E DIRITTO PER L\u0027ECONOMIA"
         }
      }
   ],
   "contactSet":[
      {
         "description":"123123123123213",
         "contactType":{
            "id":20231,
            "description":"mobile"
         },
         "mainContact":false
      }
   ],
   "description":"FGDGD",
   "keywordAtecoSet":[
      {
         "keyword":{
            "code":"55.20.30",
            "id":2199,
            "description":"55.20.30 - Rifugi di montagna belli"
         }
      }
   ],
   "publicationWorkgroupSet":[
      {
         "itemId":"199302",
         "title":"Private Equity-Backed Firms’ Corporate Strategy: An Explorative Study from a Dynamic Capability Perspective",
         "handle":"10281/155546",
         "contributors":"Ciao, B",
         "year":"2016"
      },
      {
         "itemId":"182349",
         "title":"Embrained Knowledge Defining the Boundaries of Small Firms",
         "handle":"10281/138912",
         "contributors":"Ciao, B",
         "year":"2016"
      },
      {
         "itemId":"182344",
         "title":"Leadership Succession as a Microfoundation of Dynamic Capability for Family Business",
         "handle":"10281/138885",
         "contributors":"Ciao, B",
         "year":"2015"
      }
   ],
   "workgroupLinkSet":[
      {
         "child":{
            "description":"prova",
            "id":16736
         },
         "parent":{
            "description":"FGDGD",
            "id":16755
         }
      }
   ],
   "startDate":"2017-04-11T00:00:00",
   "researchLineSet":[
      {
         "researchLine":"qwewqewqe",
         "researchLine_en":"wqeqweqweweq"
      }
   ],
   "endDate":"2018-02-28T00:00:00",
   "visibleOnPortal":false,
   "abstract":"feffwe",
   "acronym":"fewa3rk",
   "workgroupWebsiteSet":[
      {
         "description":"www",
         "websiteUrl":"www"
      }
   ]
}
							
BASE OUTPUT: https://air.unimi.it/gw/rest/api/workgroups?id=12345 [collapse]

Example
   
{
   "id":16755,
   "displayValue":"FGDGD",
   "year":2017,
   "ownerSet":[
      {
         "person":{
            "firstName":"GINO",
            "idAb":"107034",
            "id":2480,
            "pid":"rp02161",
            "cf":"XXXXXXXXXXXXXXXX",
            "ORCID":"0000-0003-1480-335X",
            "lastName":"CIAO"
         }
      }
   ],
   "ownerPersonCurrentOrLastInternalOrganizationUnitSet":[
      {
         "organizationUnit":{
            "id":4407,
            "description":"DIPARTIMENTO DI SCIENZE ECONOMICO-AZIENDALI E DIRITTO PER L\u0027ECONOMIA"
         }
      }
   ],
   "wfState":{
      "id":666,
      "description":"draft"
   }
}

							
Back to summary

/gw/rest/api/patents

Methods

GET 

/gw/rest/api/patents

All parameters marked with a "*" can be used as an identifier to get a single resource as explained in this section
In FULL version only "starred" query parameters are usable: the other are silently ignored
All parameters surrounded by square brackets [...] accept multiple values.
Available sort fields: id, pid, name, year, startDate, lastModified, wfItemType.identifier, wfItemType.description

Request Query Parameters
parameter value description

*[id]

string

a String containing the ID of the item. See response for values

*[pid]

string

a String containing the persistent identifier. See response for values

[type]

string

a String containing the item type. Contact IRIS helpdesk for all available types

active

boolean

This parameter allows the filtering based on the item "currentness" that is inferred from the specified endDate. The only allowed values are true|false. If not provided, all items are returned.

validation.relation

string

The only allowed values are master|mostValidated|all. If not provided mostValidated is assumed. More info

visibleOnPortal

boolean

This parameter allows the filtering of items based on the grant given by creator. The only allowed values are true|false. If not provided, all items are returned.

year

number

Item create year

wfState

string

a String containing the wfState of the item. See response for values

name

string

a String containing the description of the item. "*" character can be used. See response for values

person.id

string

a String containing the IRIS person id. See response for values

person.idAb

string

a String containing the Person idAb. See response for values

person.cf

string

a String containing the Person CF (Codice Fiscale). See response for values

person.sourceId

string

a String containing the Person (for universities not using U-GOV). See response for values

person.pid

string

a String containing the Person PID (IRIS IR). See response for values

person.orcid

string

a String containing the Person ORCID. See response for values

person.relation

owner|contributor

This field select a specific relation for a person. This field is intended in association with other person filters like person.cf. If you don't specify this field, all kind of relation is selected. See examples.

department.id

string

a String containing the department id. See response for values

department.idAb

string

a String containing the department idAb (U-GOV). See response for values

department.sourceId

string

a String containing the department sourceId (for universities not using U-GOV). See response for values

department.relation

owner|contributor

This parameter allows to specify the department role: main(owner) or secondary (contributor) Only owner|contributor values are allowed. This field must be used in association with other department filters like department.idAb. If specified, only the items that match the specified department and the role are returned. If not provided, all items that match the specified department are returned. See examples.

department.match

byPerson|byDepartment

This parameter allows to specify the department match strategy: byPerson or byDepartment Only byPerson|byDepartment values are allowed. This field must be used in association with other department filters like department.idAb. If not provided, both strategy match are used otherwise only the one specified. The "byPerson" strategy infers the current department from the person owner/contributor The "byDepartment" strategy extract the department at item creation time. See examples.

patent.applicationNumber

string

a String containing the applicationNumber of the item. See response for values

patent.familyIdentifier

string

a String containing the family identifier of the item. See response for values

patent.patentNumber

string

a String containing the patent number of the item. See response for values

patent.priorityNumber

string

a String containing the priority number of the item. See response for values

patent.publicationNumber

string

a String containing the publication number of the item. See response for values

patent.isPriority

boolean

This parameter allows the filtering of priority patents. The only allowed values are true|false. If not provided, all items are returned.

lastModified.min

date format YYYY-MM-DDTHH:MM:SSZ

get items from items lastmodified date

lastModified.max

date format YYYY-MM-DDTHH:MM:SSZ

get items to items lastmodified date

Examples:
To search all Item

					https://air.unimi.it/gw/rest/api/patents
					
To search Item with CF like 123456

					https://air.unimi.it/gw/rest/api/patents?person.cf=UYGUSGAUYGUGY
					
To search all the people with idAb like 123456

					https://air.unimi.it/gw/rest/api/patents?person.idAb=123456&
					
To search all the deprtment with idAb like 123456:

					https://air.unimi.it/gw/rest/api/patents?department.idAb=123456
					
To search a patents on witch its owner had a current(by person) or past (byDepartment) department id 4400

					https://air.unimi.it/gw/rest/api/patents?department.relation=owner&department.match=byPerson&department.id=4400
					

available response representations:

FULL OUTPUT: https://air.unimi.it/gw/rest/api/patents;full/id=12345 [collapse]

Example

							
Back to summary

/gw/rest/api/files

Methods

GET 

/gw/rest/api/files/{blobId}

For more information refer to File Retrieval section
Back to summary