Détection de l'API REST Excel Services

Article
05/09/2023

Cette rubrique décrit les mécanismes de découverte intégrées à l'API REST 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.

URL de Base de la découverte et de détection-exemple

Découverte permet aux développeurs et aux utilisateurs de découvrir des informations sur et le contenu d'un classeur manuellement ou par programme. Le mécanisme de découverte fournit le flux Atom qui contient des informations sur les ressources d’un classeur. À l'aide de la découverte, vous pouvez Explorer et afficher les ressources dans le classeur. Les ressources que vous pouvez Explorer et accéder sont des plages, des graphiques, des tableaux et des tableaux croisés dynamiques.

Voici la construction de l'URL REST pour un élément spécifique dans un classeur :

http://<ServerName>/_vti_bin/ExcelRest.aspx/<DocumentLibrary>/<FileName>/<ResourceLocation>

Comme décrit dans la rubrique Structure et chemin d’URI de base , voici l’URL REST permettant d’accéder à un classeur nommé sampleWorkbook.xlsx et d’afficher davantage le graphique appelé SampleChart :

http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart')

Pour démarrer et Explorer les ressources dans le classeur et afficher les ressources à l'aide de détection, accédez à la page de modèle à l'aide d'un URI qui suit cet exemple :

http://<ServerName>/_vti_bin/ExcelRest.aspx/<DocumentLibrary>/<FileName>/model

À l’aide de l’exemplesampleWorkbook.xlsx, voici l’URI :

http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model

Voici une capture d'écran de la page de modèle.

URL de modèle REST Excel Services

URL de modèle REST Excel Services

L'URL de la page de modèle est où vous démarrez la détection. La page de modèle affiche quatre collections de ressources prenant en charge l'API REST Excel Services actuellement. Les ressources sont des plages, graphiques, tableaux ou tableaux croisés dynamiques. Explorez ces ressources dans un classeur particulier en cliquant sur plages, graphiques, tableaux ou tableaux croisés dynamiques dans la page de modèle.

Par exemple, pour accéder au graphique dans le classeur à l'aide de détection, procédez comme suit :

Dans la page de modèle, cliquez sur graphiques. En cliquant sur le lien de graphiques apporte une autre flux Atom ce flux résultant répertorie tous les graphiques sont disponibles dans le classeur sampleWorkbook.xlsx. Le classeur sampleWorkbook.xlsx contient trois graphiques nommés Chart1, graphique 3 et SampleChart. Par conséquent, les trois noms de graphique sont répertoriés, comme illustré dans la capture d'écran suivante.

Liste des graphiques de découverte REST Excel Services
Dans la page du modèle, cliquez sur SampleChart. Cela affiche le graphique nommé SampleChart qui réside dans sampleWorkbook.xlsx, comme illustré dans la capture d’écran suivante.

Affichage du graphique avec REST
De même, le fait de cliquer sur Graphique 1 ou Graphique 3 affiche le graphique portant le nom correspondant. Cliquez sur SampleChart pour accéder à l’URL réelle du graphique. Voici l’URL de l’image SampleChart (comme illustré dans la capture d’écran) :
```
http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image
```

Flux Atom

L’utilisation du flux Atom fourni par l’API REST vous permet d’accéder plus facilement aux données qui vous intéressent. Si vous affichez la source de la page web, vous obtenez le code XML. Un exemple des graphiques dans sampleWorkbook.xlsx est illustré ci-dessous.

Comme on peut le voir dans le code XML, le flux contient des éléments traversables qui permettent au code de découvrir quels éléments existent dans le classeur. Chaque entrée Atom correspond à un graphique accessible. Ce même mécanisme s’applique à la découverte de plages, de tables et de tableaux croisés dynamiques.

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:x="http://schemas.microsoft.com/office/2008/07/excelservices/rest"
      xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservice"
      xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <title type="text">Charts</title>
  <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts</id>
  <updated>2010-01-19T19:32:53Z</updated>
  <author>
    <name />
  </author>
  <link rel="self" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts?$format=atom" title="Charts" />
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>Chart 1</title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="Chart 1" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%201')?$format=image" />
  </entry>
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>Chart 3</title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="Chart 3" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('Chart%203')?$format=image" />
  </entry>
  <entry>
    <category term="ExcelServices.Chart" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
    <title>SampleChart </title>
    <id>http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')</id>
    <updated>2010-01-19T19:32:53Z</updated>
    <author>
      <name />
    </author>
    <link rel="alternate" title="SampleChart" href="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image" />
    <content type="image/png" src="http://ServerName/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image" />
  </entry>
</feed>

Voir aussi

Concepts

URI des ressources pour l'API REST Excel Services

Partager via

Détection de l'API REST Excel Services

URL de Base de la découverte et de détection-exemple

Flux Atom

Voir aussi

Concepts

Ressources supplémentaires