Servizio REST di SharePoint
SharePoint include un servizio REST (Representational State Transfer) paragonabile ai modelli a oggetti client di SharePoint esistenti. Ora gli sviluppatori possono interagire da remoto con i dati di SharePoint usando qualsiasi tecnologia che supporti le richieste Web REST. In sostanza, gli sviluppatori possono eseguire operazioni di creazione, lettura, aggiornamento ed eliminazione (operazioni CRUD) da componenti aggiuntivi, soluzioni e applicazioni client di SharePoint usando le tecnologie Web REST e la sintassi standard Open Data Protocol (OData).
Funzionamento del servizio REST di SharePoint
SharePoint consente di interagire da remoto con i siti SharePoint usando REST. Ora è possibile interagire direttamente con gli oggetti SharePoint usando qualsiasi tecnologia che supporti le funzionalità REST standard.
Per accedere alle risorse SharePoint con REST, è possibile creare una richiesta HTTP RESTful usando lo standard OData, che corrisponde all'API del modello a oggetti client desiderato, come mostrato nell'esempio seguente:
GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Uso dei comandi HTTP con il servizio REST di SharePoint
Per usare le funzionalità REST predefinite in SharePoint, è possibile creare una richiesta HTTP RESTful usando lo standard OData, che corrisponde all'API del modello a oggetti client che si vuole usare. Il servizio Web client.svc gestisce la richiesta HTTP e fornisce la risposta appropriata in formato Atom o JSON. L'applicazione client deve quindi analizzare la risposta.
Gli endpoint nel servizio REST di SharePoint corrispondono ai tipi e ai membri nei modelli a oggetti client di SharePoint. Con le richieste HTTP, è possibile usare questi endpoint REST per eseguire operazioni CRUD comuni sulle entità di SharePoint, come elenchi e siti.
La tabella seguente fornisce una panoramica delle richieste HTTP.
| Azione | Richiesta HTTP | Ricordare |
|---|---|---|
| Leggere una risorsa | GET | Potrebbe essere necessario modificare il formato dei dati restituiti. |
| Creare o aggiornare una risorsa | POST | Usare POST per creare entità come elenchi e siti. Il servizio REST di SharePoint supporta l'invio di comandi POST che includono definizioni degli oggetti agli endpoint che rappresentano le raccolte. Per le operazioni POST, le proprietà non richieste vengono impostate sui valori predefiniti. Se si prova a impostare una proprietà di sola lettura come parte di un'operazione POST, il servizio restituisce un'eccezione. |
| Aggiornare o inserire una risorsa | PUT | Usare le operazioni PUT e MERGE per aggiornare gli oggetti SharePoint esistenti. Tutti gli endpoint del servizio che rappresentano un'operazione di impostazione delle proprietà dell'oggetto supportano le richieste PUT e MERGE. Per le richieste MERGE, l'impostazione delle proprietà è facoltativa. Le proprietà non impostate esplicitamente mantengono la proprietà corrente. Per le richieste PUT, se non si specificano tutte le proprietà richieste negli aggiornamenti degli oggetti, il servizio REST restituisce un'eccezione. Le proprietà facoltative non specificate in modo esplicito vengono impostate sulle proprietà predefinite. |
| Eliminare una risorsa | DELETE | Usare il comando HTTP DELETE sull'URL dell'endpoint specifico per eliminare l'oggetto SharePoint rappresentato dall'endpoint. Sono disponibili oggetti riciclabili, come elenchi, file ed elementi dell'elenco, che consentono di eseguire un'operazione di riciclo. |
Creazione di URL REST per accedere a risorse SharePoint
SharePoint usa le API REST. Un'API è un intermediario software che consente a due applicazioni di dialogare tra loro. Ogni volta che si apre un'app sul telefono per controllare il meteo, si usa un'API.
Per creare gli endpoint del servizio REST di SharePoint, seguire questi passaggi:
Iniziare con il riferimento al servizio REST:
https://{site_url}/_apiSpecificare il punto di ingresso appropriato, ad esempio:
https://{site_url}/_api/webEsempio:
https://contoso.sharepoint.com/_api/webPassare dal punto di ingresso alle risorse specifiche a cui accedere, specificando anche i parametri per gli endpoint che corrispondono ai metodi nel modello a oggetti client, ad esempio:
https://{site_url}/_api/web/lists/getbytitle('list_name')Esempio:
https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')