Utilisation d’OData avec REST Excel Services dans SharePoint

  • Article

SharePoint Server 2010 a introduit l’API REST pour une utilisation des informations d’obtention et de définition dans des classeurs Excel stockés dans des bibliothèques de documents SharePoint. SharePoint ajoute une nouvelle méthode pour demander des données à partir d’ Excel Services qui utilisent Open Data Protocol (OData) que vous pouvez utiliser pour obtenir des informations relatives aux ressources Excel Services. Ce nouveau service s'appuie sur l' existant Excel Services API REST.Cette rubrique fournit une vue d'ensemble de l'utilisation d'OData dans Excel Services.

Remarque

L’API REST Excel Services s’applique à l’environnement local SharePoint et SharePoint 2016. Pour les comptes Office 365 Éducation, Business et Entreprise, utilisez les API REST Excel qui font partie du point de terminaison Microsoft Graph.

Présentation d’ OData

OData est un protocole d'ouvrir un site web pour l'interrogation et la mise à jour des données. Il utilise une approche RESTful pour renvoyer des données à partir des ressources sur le web. En d'autres termes, vous utilisez un URI avec des paramètres de requête inclus pour obtenir des informations sur une ressource spécifique.

Pour plus d’informations sur OData, consultez le site web de la spécification Open Data Protocol.

Comment utiliser OData avec Excel Services ?

Dans le cas Excel Services, vous utilisez OData pour obtenir des informations concernant les tables (y compris les tables de requête) dans un classeur qui est stocké dans une bibliothèque de SharePoint. Configuration du service OData renvoie les données que vous avez demandé dans au format Atom XML.

Syntaxe pour effectuer les requêtes OData dans Excel Services

SharePoint expose chaque classeur sous la forme d'une ressource distincte que vous pouvez demander des informations à partir de. Dans cette version de SharePoint Server, vous pouvez uniquement obtenir des données à partir des tables dans le classeur.

Pour obtenir des données à partir d'un classeur Excel, vous construisez une URL qui pointe vers le classeur, et qui spécifie les données que vous souhaitez obtenir le classeur et comment organiser les données. Par exemple, pour obtenir des informations sur la Table1 dans un classeur nommé ProductSales.xlsx qui est stocké dans une bibliothèque de SharePoint dans un dossier nommé Documents, vous devrez utiliser une URL comme suit.

http://<serverName>/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1

Pour plus d’informations sur l’utilisation d’OData pour demander des informations à partir d’un classeur Excel stocké sur SharePoint Server, voir Demande de données de classeur Excel à partir de SharePoint Server à l’aide d’OData.

Données renvoyées par OData

Lorsque vous effectuez une requête OData pour Excel Services, elle renvoie des données XML au format Atom. Le format Atom est le seul format pris en charge dans l'implémentation de Excel Services de OData. Par exemple, voici une requête OData pour la première ligne du premier tableau (intitulée Table1) dans un classeur nommé WindowsPhoneComparison.xlsx.

http://<serverName>/_vti_bin/ExcelRest.aspx/Documents/WindowsPhoneComparison.xlsx/odata/Table1

Excel Services renvoie ensuite le code XML atome illustré dans le code suivant.


<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<entry xml:base="http://{serverName}/_vti_bin/ExcelRest.aspx/Documents/WindowsPhoneComparison.xlsx/OData" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" m:etag="W/&amp;quot;datetime'0001-01-01T00%3A00%3A00'&amp;quot;" xmlns="http://www.w3.org/2005/Atom">
  <id>http://{serverName}/_vti_bin/ExcelRest.aspx/Documents/WindowsPhoneComparison.xlsx/OData/Table1(0)</id>
  <title type="text"></title>
  <updated>0001-01-01T00:00:00-08:00</updated>
  <author>
    <name />
  </author>
  <link rel="edit" title="Table1Item" href="/Table1(0)" />
  <category term="ExcelServices.Table1Item" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <content type="application/xml">
    <m:properties>
      <d:Phone>Samsung Focus</d:Phone>
      <d:sizeweight m:type="Edm.Double">4</d:sizeweight>
      <d:camera m:type="Edm.Double">2.5</d:camera>
      <d:battery m:type="Edm.Double">3</d:battery>
      <d:memory m:type="Edm.Double">3</d:memory>
      <d:speed m:type="Edm.Double">3</d:speed>
      <d:style m:type="Edm.Double">3</d:style>
      <d:callquality m:type="Edm.Double">3</d:callquality>
      <d:overall m:type="Edm.Double">3</d:overall>
      <d:excelRowID m:type="Edm.Int32">0</d:excelRowID>
    </m:properties>
  </content>
</entry>

Conclusion

OData offre un moyen simple pour obtenir des données à partir de classeurs Excel qui sont stockés dans SharePoint. En utilisant une syntaxe simple qui est basée sur des normes web comme HTTP et REST, OData vous permet de rapidement et facilement obtenir des données à partir de classeurs de Excel.

Voir aussi