Page History

Introduzione

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

...

Se si tratta della prima lettura, si consiglia di consultare il documento, altrimenti è possibile passare ai dettagli del servizio REST.

Autenticazione e autorizzazione

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

Convenzioni sugli URI REST

Le API GW REST forniscono accesso alle risorse (entità dati) tramite i percorsi URI in base alle convenzioni REST e agli standard RFC HTTP.
Tutte le risposte sono in formato JSON e dalla versione v1 sono permesse solo richieste GET.
Gli URI dell'API REST di GW seguono questo schema:

...

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

Parametri di filtro per le richieste REST

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

...

Ciascuna delle precedenti richieste restituisce un array JSON contenente l'oggetto corrispondente [{}].
Tutti gli identificatori disponibili per ogni tipo di risorsa sono elencati nella sezione specifica per ogni raccolta.
Se non viene fornito alcun tipo di identificatore, l'uso dell'identificatore "id" è implicito.

Convenzioni sulle risposte REST

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

...

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

Risultati di ricerca e ordinamento REST

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

...

I filtri di ordinamento utilizzabili effettivi per un tipo di risorsa specifico sono specificati nei dettagli del servizio REST.

Gestione degli errori REST

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

...

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

Controllo di versione delle risorse REST

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

...

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

Controllo di versione degli Endpoint REST

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

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

Dettagli del servizio REST

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

...

/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

Examples:

To search all Item

					https://arts.units.it/gw/rest/api/academic-areas
					

...