Interface REST SharePoint Foundation
Dernière modification : mercredi 1 décembre 2010
S’applique à : SharePoint Foundation 2010
Disponible dans SharePoint Online
La nouvelle interface REST (Representational State Transfer) dans Microsoft SharePoint Foundation 2010 donne accès à des listes et à des bibliothèques en tant que service de données relationnelles. Un concept fondamental de toute interface RESTful est la ressource, et, dans SharePoint Foundation, les listes et les éléments sont représentés en tant que ressources HTTP vers lesquelles peuvent pointer des URL distantes.
Les opérations dans l’interface REST SharePoint Foundation constituent un jeu standard d’opérations pour les services Web RESTful. Les opérations de lecture, de création, de mise à jour et de suppression sont mappées directement sur les verbes HTTP GET, POST, PUT et DELETE. Cela permet de s’affranchir de couches intermédiaires entre le client et le serveur et cela s’avère utile en termes d’interopérabilité, car les applications situées sur d’autres plateformes peuvent facilement se connecter à SharePoint Foundation. L’interopérabilité est l’un des avantages de la nouvelle interface REST SharePoint Foundation, mais celle-ci procure également une expérience de développement saisissante grâce à son intégration à ADO.NET Data Services, sur lequel elle repose.
L’interface REST utilise des conventions URL souples pour l’interrogation des données, qui vous permettent de filtrer, trier et sélectionner les informations des listes SharePoint Foundation directement à partir du navigateur. Vous pouvez également récupérer des informations de listes SharePoint Foundation par le biais de plusieurs représentations, notamment grâce à la prise en charge des normes JSON (JavaScript Object Notation), Atom et AtomPub. Les représentations standard pour les listes SharePoint Foundation rendent les données de liste accessibles aux clients compatibles avec les normes, des simples lecteurs de flux Atom aux clients plus avancés qui permettent aux utilisateurs finaux d’analyser de grandes quantités de données dans Microsoft Excel. Les fonctionnalités avancées d’ADO.NET Data Services sont également prises en charge par l’interface REST SharePoint Foundation, telles que le traitement par lots de plusieurs opérations dans une demande unique, le contrôle de simultanéité par le biais de balises HTTP ETag, la pagination des jeux de données volumineux et l’accès aux flux de documents dans les bibliothèques de documents SharePoint.
Le tableau suivant montre des exemples d’URL qui implémentent l’interface REST.
URL |
Description |
|---|---|
http://monserveur/_vti_bin/ListData.svc |
La saisie de l’URL du service REST permet d’obtenir un document de service Atom standard qui décrit les collections d’informations disponibles sur le site SharePoint Foundation. |
http://monserveur/_vti_bin/ListData.svc/Projects |
La saisie d’un nom après l’URL du service permet d’obtenir des données de liste SharePoint Foundation au format XML en tant que flux Atom standard qui contient des entrées pour chaque élément de liste et les propriétés de chaque élément, outre les propriétés de navigation représentées sous la forme de liens Atom. Les propriétés de navigation représentent les relations avec les autres listes SharePoint Foundation formées par le biais des colonnes de recherche. |
http://monserveur/_vti_bin/ListData.svc/$metadata |
L’interface SharePoint Foundation retourne du XML de modèle de données d’entité qui décrit les types d’entité pour chaque liste sur le site Web. |
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees(2) |
Retourne l’élément de liste spécifié d’après l’ID (2) sous la forme d’un flux Atom qui contient une entrée correspondant à l’élément demandé. |
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$orderby=Name |
Trie le flux Atom par nom. |
http://lsspf4719/sites/TestWebs/_vti_bin/listdata.svc/Employees?$filter=Project/Title eq 'titre_projet' |
Utilise une propriété de navigation pour filtrer la liste en fonction du titre d’un projet connexe. |
En tirant parti des nouvelles fonctionnalités du magasin de données SharePoint Foundation, les requêtes REST offrent un mécanisme souple pour manipuler les données de liste SharePoint Foundation au format XML, et n’importe quelle application pouvant envoyer des URL REST à SharePoint Foundation peut récupérer ses données de liste. Par exemple, l’interface REST utilise les nouvelles fonctionnalités de listes de jointures ; par conséquent, lorsque SharePoint Foundation reçoit une requête ADO.NET Data Services qui implémente la fonctionnalité de jointures, la requête est convertie en une requête CAML (Collaborative Application Markup Language) native.
Voir aussi
Concepts
Effectuer des requêtes sur SharePoint Foundation avec ADO.NET Data Services
Jointures de listes et projections