Usar OData con REST de Excel Services en SharePoint

2023-03-21

SharePoint Server 2010 introduce la API de REST para obtener y establecer la información en libros de Excel almacenados en bibliotecas de documentos de SharePoint. SharePoint agrega una nueva forma a los datos de la solicitud de Excel Services que utiliza Open Data Protocol (OData) que puede utilizar para obtener información acerca de los recursos de Excel Services. Este nuevo servicio depende en gran medida existente Servicios de Excel API de REST.Este tema proporciona una introducción de alto nivel de utilización de OData en Servicios de Excel.

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.

¿Qué es OData?

OData es un protocolo web abierto para realizar consultas y actualizar datos. Utiliza un enfoque RESTful para devolver datos de recursos en el web. Es decir, utilizar un URI con parámetros de consulta para obtener información acerca de un recurso específico.

Para obtener más información sobre OData, vea el sitio web de la especificación open data protocol.

¿Cómo usar OData con Excel Services?

En el caso de Servicios de Excel, utilice OData para obtener información acerca de las tablas (incluidas las tablas de consulta) en un libro que está almacenado en una biblioteca de SharePoint. El servicio de OData devuelve los datos solicitados en el en el formato Atom XML.

Sintaxis para realizar las solicitudes de OData en Excel Services

SharePoint expone cada libro como un recurso independiente que puede solicitar información de. En esta versión de SharePoint Server, sólo puede obtener los datos de las tablas del libro.

Para obtener datos desde un libro de Excel, construir una dirección URL que señala al libro y que especifica los datos que desea obtener en el libro y cómo organizar los datos. Por ejemplo, para obtener información acerca de la Tabla1 en un libro denominado ProductSales.xlsx que se almacena en una biblioteca de SharePoint en una carpeta que se denomina documentos, utilizaría una dirección URL como sigue.

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

Para obtener más información sobre cómo usar OData para solicitar información de un libro de Excel almacenado en SharePoint Server, vea Solicitud de datos de libro de Excel desde SharePoint Server mediante OData.

Datos devueltos por OData

Al realizar una solicitud de OData para Servicios de Excel, devuelve XML con el formato Atom. El formato Atom es el único formato compatible en la implementación de Servicios de Excel de OData. Por ejemplo, la siguiente muestra una solicitud de OData para la primera fila de la primera tabla (denominada Tabla1) en un libro denominado WindowsPhoneComparison.xlsx.

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

Excel Services devuelve el XML de Atom se muestra en el siguiente código.


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

Conclusión

OData proporciona una forma sencilla de obtener datos de libros de Excel que se almacenan en SharePoint. Mediante una sintaxis sencilla que se basa en estándares web como HTTP y el resto, OData permite rápidamente y obtener fácilmente datos de libros de Excel.

Compartir a través de