Service REST SharePoint

Effectué

SharePoint inclut un service REST (Representational State Transfer) comparable aux modèles d’objet client existants de SharePoint. Désormais, les développeurs peuvent interagir à distance avec les données SharePoint en utilisant n’importe quelle technologie prenant en charge les requêtes web REST. Fondamentalement, les développeurs peuvent effectuer des opérations de création, de lecture, de mise à jour et de suppression (CRUD) de leurs compléments, solutions et applications clientes SharePoint à l’aide des technologies web REST et de la syntaxe OData (Open Data Protocol) standard.

Fonctionnement du service REST SharePoint

SharePoint vous offre la possibilité supplémentaire d’interagir à distance avec les sites SharePoint à l’aide de REST. Désormais, vous pouvez interagir directement avec les objets SharePoint en utilisant n’importe quelle technologie prenant en charge les fonctionnalités REST standard.

Pour accéder aux ressources SharePoint en utilisant REST, vous pouvez créer une requête HTTP RESTful en suivant la norme OData, qui correspond à l’API de modèle d’objet client souhaitée, comme illustré dans l’exemple suivant :

GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"

Utiliser les commandes HTTP avec le service REST SharePoint

Pour utiliser les fonctionnalités REST intégrées à SharePoint, vous pouvez créer une requête HTTP RESTful en suivant la norme OData, qui correspond à l’API de modèle d’objet client que vous souhaitez utiliser. Le service web client.svc traite la requête HTTP et sert la réponse appropriée au format Atom ou JSON. Ensuite, l’application cliente doit analyser cette réponse.

Les points de terminaison dans le service REST SharePoint correspondent aux types et aux membres des modèles d’objet client SharePoint. En utilisant des requêtes HTTP, vous pouvez utiliser ces points de terminaison REST pour effectuer des opérations CRUD ordinaires sur les entités SharePoint, telles que des listes et des sites.

Le tableau suivant fournit un aperçu des requêtes HTTP.

Action Requête HTTP À ne pas oublier
Lire une ressource GET Le format des données renvoyées doit éventuellement être modifié.
Créer ou mettre à jour une ressource POST Utilisez POST pour créer des entités telles que des listes et des sites. Le service REST SharePoint prend en charge l’envoi de commandes POST qui incluent des définitions d’objet aux points de terminaison qui représentent des collections. Pour les opérations POST, les propriétés qui ne sont pas obligatoires sont définies sur leurs valeurs par défaut. Si vous essayez de définir une propriété en lecture seule dans le cadre d’une opération POST, le service renvoie une exception.
Mettre à jour ou insérer une ressource PUT Utilisez les opérations PUT et MERGE pour mettre à jour les objets SharePoint objets. Tout point de terminaison de service qui représente une opération sur un ensemble de propriétés d’objet prend en charge les requêtes PUT et MERGE. Pour les requêtes MERGE, la définition des propriétés est facultative ; les propriétés que vous ne définissez pas explicitement conservent leur propriété actuelle. Pour les requêtes PUT, si vous ne spécifiez pas toutes les propriétés requises dans les mises à jour d’objets, le service REST renvoie une exception. Les propriétés facultatives que vous ne spécifiez pas explicitement sont définies sur leurs propriétés par défaut.
Supprimer une ressource DELETE Utilisez la commande HTTP DELETE sur l’URL du point de terminaison spécifique pour supprimer l’objet SharePoint représenté par ce point de terminaison. Des objets recyclables sont disponibles, tels que des listes, des fichiers et des éléments de liste, ce qui entraîne une opération de recyclage.

Construire des URL REST pour accéder aux ressources SharePoint

SharePoint utilise des API REST. Une API est un intermédiaire logiciel qui permet à deux applications de communiquer. Chaque fois que vous utilisez une application sur votre téléphone pour vérifier la météo, vous utilisez une API.

Pour construire des points de terminaison REST SharePoint, procédez comme suit :

  1. Commencez par la référence du service REST :

    https://{site_url}/_api

  2. Spécifiez le point d’entrée approprié, par exemple :

    https://{site_url}/_api/web

    Exemple : https://contoso.sharepoint.com/_api/web

  3. Passez du point d’entrée aux ressources spécifiques auxquelles vous souhaitez accéder, notamment en spécifiant des paramètres pour les points de terminaison qui correspondent aux méthodes du modèle d’objet client. Par exemple :

    https://{site_url}/_api/web/lists/getbytitle('list_name')

    Exemple : https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')