Référence de l'API REST BCS pour SharePoint
Contient des informations de référence pour la construction d’URL REST (Representational State Transfer) pour accéder à des sources de données externes et les manipuler à l’aide de Business Connectivity Services (BCS) dans SharePoint.
Utilisation des API RESTful pour accéder à des données externes dans SharePoint
L’interface REST fournie par SharePoint vous permet d’accéder à la plupart des ressources SharePoint via des URL spécialement construites. Business Connectivity Services (BCS) utilise cette architecture pour fournir l'accès aux données externes.
Vous pouvez accéder des données externes en construction URL comme vous le feriez pour accéder aux éléments de liste standard.
Remarque
[!REMARQUE] Accès à des entités directement du BDC n'est pas fourni. Pour travailler avec des données externes, vous devez créer une liste externe et les URL REST permet d'accéder aux éléments de liste contenus dans la liste externe.
Les verbes HTTP prises en charge pour travailler avec des listes externes sont GET, PUT, POSTet DELETE.
Contrairement aux listes normal, vous ne pouvez créer une liste externe à l'aide de REST. Vous devez le faire en créant un modèle BDC et une liste externe à l'aide de Visual Studio 2012.
Les informations contenues dans le tableau 1 montre comment construire des URL RESTful et les appels de modèle objet client correspondante pour accéder et manipuler des données à partir de sources de données externes.
Tableau 1. Formats d’URL RESTful pour l’accès aux données externes
| URL | Description | HTTP method |
|---|---|---|
http://[sharepointsite]/_api |
La base de toutes les demandes REST. Le répertoire virtuel _api est mappé pour appeler client.svc, où le modèle objet client peut être utilisé. |
GET |
http://[sharepointsite]/_api/web/title |
Récupère le titre du site web actuel. |
GET |
http://[sharepointsite]/_api/lists |
Récupère toutes les listes d'un site |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname') |
Récupère les métadonnées pour une liste spécifiée. |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname')/items |
Récupère les éléments de liste dans une liste spécifiée. |
GET |
http://[sharepointsite]/_api/lists/getbytitle('listname')?select=Title |
Récupère le titre d'une liste spécifique. |
GET |
Construction des chaînes de requête pour filtrer les données
Afin de limiter la quantité de données renvoyées, ou pour la rendre plus pertinents pour l'utilisateur, vous pouvez utiliser les opérations de filtrage trouvées dans le tableau 2.
Tableau 2. Opérateurs pour le filtrage des données
| Opérateur | Description |
|---|---|
| eq |
Égal à Remarque : Lorsque vous utilisez EQ pour filtrer, les critères de filtre sont passés au système externe où le filtrage se produit sur le serveur. |
| Gt |
Supérieur à Remarque : Lorsque vous utilisez l’opérateur GT , seul le filtrage côté client est exécuté.> Par exemple : web/lists/getByTitle('ListName')/Items?$select=Title&$filter=AverageRating gt 3 retourne tous les titres dont la note moyenne est supérieure à 3. |
Remarque
[!REMARQUE] Pour récupérer les colonnes qui font partie d'une association, vous devez explicitement inclure la colonne dans l'URL à l'aide de $select dans la chaîne de requête.