Notes
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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.
OData utilise des URL pour demander des informations à partir d'une ressource. Vous concevoir l'URL d'une manière spécifique, à l'aide des options de requête pour renvoyer les informations que vous demandez. L'URL suivante montre ce à quoi ressemble une requête OData classique :
http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$top=20
Cet exemple de requête OData est structuré de sorte qu'il reçoive les 20 premières lignes d'une table nommée Table1 dans le classeur ProductSales.xlsx qui est stocké dans le dossier Documents sur le serveur contoso1. L'URL utilise l' option du requête système $top pour spécifier le nombre de lignes à renvoyer.Examiner l'URL, vous pouvez voir sa structure de trois parties : la racine du service URI ; le chemin d'accès de la ressource ; et les options de requête.
URI racine du service
La partie initiale de l’URL est appelée racine du service. Elle est identique pour chaque demande OData que vous adressez à un serveur SharePoint, à l’exception du nom du serveur. Elle inclut le nom du serveur SharePoint sur lequel le classeur est stocké, ainsi que le chemin d’accès, _vti_bin/ExcelRest.aspx, comme dans l’exemple suivant :
http://contoso1/_vti_bin/ExcelRest.aspx
Chemin d’accès de la ressource
La deuxième partie de l’URL contient le chemin d’accès au feuille de calcul Excel et indique qu’il s’agit d’une demande OData : /Documents/ProductSales.xlsx/OData
Options de requête de système
La troisième partie de l'URL fournit des options de requête pour la demande au système. Options de requête toujours commencent par un signe dollar ($) et sont ajoutées à la fin de l'URI en tant que paramètres de requête. Dans cet exemple, la demande concerne les 20 premières lignes de la table nommée Table1 : /Table1?$top=20
Options de requête de système fournissent un moyen d'obtenir des données spécifiques à partir d'une ressource. L'implémentation d'Excel Services OData prend en charge un nombre d'options de requête, comme indiqué dans la section suivante.
L'implémentation d'Excel Services de OData prend en charge un nombre des options de requête OData système standard. Ces options de requête sont au cœur de demandes d'OData, étant donné que vous utilisez les options pour spécifier les données que vous souhaitez obtenir à partir d'une ressource. Le tableau suivant répertorie les options de requête système actuellement prend en charge la mise en œuvre de Excel Services de OData.
Tableau 1. Options de requête Excel Services OData système
| Option de requête de système | Description |
|---|---|
<tableName> |
Renvoie toutes les lignes de l'objet table spécifié par < tableName >, où < tableName > est le nom d'une table dans un classeur Excel qui contient les lignes que vous souhaitez récupérer. Important : cette forme de demande OData ne renvoie pas plus de 500 lignes à la fois. Each set of 500 rows is one page. Pour obtenir des lignes dans d’autres pages d’un tableau qui compte plus de 500 lignes, utilisez l’option $skiptoken requête Plus (voir ci-dessous). L’exemple suivant renvoie toutes les lignes jusqu’à la 500e ligne de la Table1 dans le modèle ProductSales.xlsx. |
| $metadata | Renvoie toutes les tables disponibles et les informations de type pour toutes les lignes de chaque table dans le classeur spécifié. L'exemple suivant renvoie les tables et les informations de type pour les tables dans le classeur ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/$metadata |
| $orderby | Renvoie les lignes dans le tableau spécifié, trié par la valeur spécifiée par $orderby. L'exemple suivant renvoie toutes les lignes du tableau 1, triés dans la colonne nom, dans le classeur ProductSales.xlsx. Remarque: la valeur par défaut de $orderby est ascending. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Name |
| $top | Cette propriété renvoie N lignes à partir de la table où N est un nombre spécifié par la valeur de $top. L'exemple suivant renvoie les 5 premières lignes from Table1, triés dans la colonne nom, dans le classeur ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Nom&$top=5 |
| $skip | Lignes ignore N, où N est le nombre spécifié par la valeur de $skipet renvoie ensuite les autres lignes du tableau. L'exemple suivant renvoie toutes les lignes restantes après la cinquième ligne from Table1 dans le classeur ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skip=5 |
| $skiptoken | Cherche à la nième ligne, où N est la position ordinale de ligne indiquée par la valeur de $skiptokenet renvoie toutes les lignes restantes, en commençant à la ligne N + 1. La collection est zéro, afin que la deuxième ligne, par exemple, est indiquée par $skiptoken = 1. L'exemple suivant renvoie toutes les lignes restantes après la deuxième ligne from Table1 dans le classeur ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=1 Vous pouvez également utiliser l’option de requête $skiptoken pour obtenir des lignes dans les pages après la première page d’une table contenant plus de 500 lignes. L'exemple suivant montre comment obtenir la ligne 500e et supérieure d'une table avec plus de 500 lignes. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=499 |
| $filter | Retourne le sous-ensemble de lignes qui répondent aux conditions spécifiées dans la valeur de $filter. Pour plus d'informations sur les opérateurs et le jeu de fonctions que vous pouvez utiliser avec $filter, consultez la documentationde OData. L'exemple suivant renvoie uniquement les lignes où la valeur de la colonne Price est supérieure à 100. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$ filter = prix gt 100 |
| $format | Au format Atom XML est la seule valeur prise en charge et la valeur par défaut pour l'option de requête $format. |
| $select | Renvoie l'entité spécifiée par $select. L'exemple suivant sélectionne la colonne nom dans Table1 dans le classeur ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$select=Name |
| $inlinecount | Renvoie le nombre de lignes du tableau spécifié. $ inlinecount peut utiliser uniquement de 1 / 2 des valeurs suivantes.
|