Utilisation d’OData avec REST Excel Services dans SharePointUsing OData with Excel Services REST in SharePoint

SharePoint Server 2010 introduit l’API REST pour une utilisation dans l’obtention et définition des informations dans des classeurs Excel stockés dans des bibliothèques de documents SharePoint.SharePoint Server 2010 introduced the REST API for use in getting and setting information in Excel Workbooks stored in SharePoint document libraries. SharePoint ajoute une nouvelle façon pour demander des données à partir d’Excel Services qui utilise Open Data Protocol (OData) que vous pouvez utiliser pour obtenir des informations sur les ressources d’Excel Services.SharePoint adds a new way to request data from Excel Services that uses the Open Data Protocol (OData) which you can use to get information about Excel Services resources. Ce nouveau service s’appuie sur l’API de REST Excel Services existante. Cette rubrique fournit une vue d’ensemble de l’utilisation d’OData dans Excel Services.This new service relies heavily on the existing Excel Services REST API.This topic provides a high-level overview for using OData in Excel Services.

Note

L’API REST Excel Services s’applique à l’environnement local SharePoint et SharePoint 2016.The Excel Services REST API applies to SharePoint and SharePoint 2016 on-premises. Pour les comptes Office 365 Éducation, Business et Entreprise, utilisez les API REST Excel qui font partie du point de terminaison Microsoft Graph.For Office 365 Education, Business, and Enterprise accounts, use the Excel REST APIs that are part of the Microsoft Graph endpoint.

What ' s OData ?What is 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.OData is an open web protocol for querying and updating data. It uses a RESTful approach to return data from resources on the web. That is, you use a URI with query parameters included to get information about a specific resource.

Pour plus d'informations sur OData, voir le site Web de la spécification Open Data Protocol.For more information about OData, see the website for the Open Data Protocol specification.

Comment utiliser OData avec Excel Services ?How do you use OData with 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.In the case of Excel Services, you use OData to get information about tables (including query tables) in a workbook that is stored in a SharePoint library. The OData service returns the data that you requested in the in the XML Atom format.

Syntaxe de requête OData dans Excel ServicesSyntax for making OData requests to 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.SharePoint exposes each workbook as a separate resource that you can request information from. In this release of SharePoint Server, you can only get data from tables in the workbook.

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.To get data from an Excel workbook, you construct a URL that points to the workbook, and that specifies what data that you want to get from the workbook, and how to arrange that data. For example, to get information about Table1 in a workbook named ProductSales.xlsx that is stored on a SharePoint library in a folder that is named Documents, you would use a URL as follows.

http://<nom_serveur>/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1http://<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, reportez-vous à la section Demande de données de classeur Excel à partir de l'utilisation d'OData de SharePoint Server.For more information about how to use OData to request information from an Excel workbook stored on SharePoint Server, see Requesting Excel workbook data from SharePoint Server using OData.

Données renvoyées par ODataData returned by 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.When you make an OData request to Excel Services, it returns XML in the Atom format. The Atom format is the only supported format in the Excel Services implementation of OData. For example, the following shows an OData request for the first row in the first table (named Table1) in a workbook named WindowsPhoneComparison.xlsx.

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

Excel Services puis retourne le Atom XML indiqué dans le code suivant.Excel Services then returns the Atom XML shown in the following code.


<?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>

ConclusionConclusion

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.OData provides a simple way to get data from Excel workbooks that are stored on SharePoint. Using a straightforward syntax that is based on web standards like HTTP and REST, OData lets you quickly and easily get data from Excel workbooks.

Voir aussiSee also