Descubrimiento en REST API de Excel Services

Este tema describen los mecanismos de detección integrados en el Servicios de Excel API de REST.

Nota:

La API de REST de Excel Services se aplica a SharePoint y a SharePoint 2016 local. Para las cuentas de Office 365 Educación, Empresa y Enterprise, use las API de REST de Excel que forman parte del punto de conexión de Microsoft Graph.

Dirección URL Base de descubrimiento y ejemplo de descubrimiento

El descubrimiento permite a los desarrolladores y usuarios para descubrir información acerca de y el contenido de un libro manualmente o mediante programación. El mecanismo de detección proporciona la fuente Atom que contiene información sobre los recursos de un libro. Mediante el descubrimiento, puede explorar y ver los recursos en el libro. Recursos que puede explorar y acceso son rangos, gráficos, tablas y tablas dinámicas.

La siguiente es la construcción de la dirección URL de REST a un elemento específico de un libro:

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

Como se describe en el tema Estructura y ruta de acceso del URI básico , a continuación se muestra la dirección URL de REST para acceder a un libro denominado sampleWorkbook.xlsx y ver más el gráfico denominado SampleChart:

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

Para iniciar y explorar los recursos en el libro y ver los recursos mediante el descubrimiento, vaya a la página de modelo utilizando un URI que sigue a este ejemplo:

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

Con el ejemplosampleWorkbook.xlsx , a continuación se muestra el URI:

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

A continuación es una captura de pantalla de la página de modelo.

Dirección URL de modelo de REST de Servicios de Excel

La dirección URL de la página de modelo es donde se inicia el descubrimiento. El modelo de página muestra cuatro conjuntos de recursos que actualmente admite la API de REST Servicios de Excel. Las colecciones de recursos son rangos, gráficos, tablas o tablas dinámicas. Puede explorar esos recursos en un libro determinado, haga clic en rangos, gráficos, tablas o tablas dinámicas en la página de modelo.

Por ejemplo, para tener acceso al gráfico en el libro mediante el descubrimiento, haga lo siguiente:

1. En el modelo de página, haga clic en gráficos. Al hacer clic en el vínculo de gráficos trae otra fuente Atom — esta fuente resultante muestra todos los gráficos que están disponibles en el libro de sampleWorkbook.xlsx. El libro de sampleWorkbook.xlsx contiene tres gráficos denominados gráfico 1, gráfico 3 y SampleChart. Por lo tanto, se muestran tres nombres de gráfico, como se muestra en la siguiente captura de pantalla.

   Lista de gráficos de detección de REST de Servicios de Excel

   

2. En el modelo de página, haga clic en SampleChart. Muestra el gráfico denominado SampleChart que se encuentra en sampleWorkbook.xlsx, como se muestra en la siguiente pantalla.

   Visualización de gráfico mediante REST

   

3. Del mismo modo, al hacer clic en Organigrama 1 o 3 del gráfico muestra el gráfico con el nombre correspondiente. Haciendo clic en SampleChart se desplaza a la dirección URL del gráfico real. Siguiente es la dirección URL de la imagen de SampleChart (como se puede ver en la captura de pantalla):

   http://<ServerName>/_vti_bin/ExcelRest.aspx/Docs/Documents/sampleWorkbook.xlsx/model/Charts('SampleChart%20')?$format=image
   

Fuente Atom

El uso de la fuente atom proporcionada por la API REST le proporciona una manera más sencilla de llegar a los datos que le interesan. Si ve el origen de la página web, obtendrá el XML. A continuación se muestra un ejemplo de los gráficos en sampleWorkbook.xlsx.

Como puede verse en el XML, la fuente contiene elementos atravesable que permiten al código descubrir qué elementos existen en el libro. Cada entrada de átomo corresponde a un gráfico que se puede tener acceso. Este mismo mecanismo se aplica al descubrimiento de rangos, tablas y tablas dinámicas.

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

Vea también

Conceptos

• Recursos de URI para Excel Services API de REST