Freigeben über


Anfordern von Excel-Arbeitsmappendaten von SharePoint Server mithilfe von OData

Hinweis

Die Excel Services-REST-API kann in lokalen Bereitstellungen von SharePoint und SharePoint 2016 verwendet werden. Verwenden Sie für Office 365 Education-, Business- und Enterprise-Konten die Excel-REST-APIs, die Bestandteil des Microsoft Graph-Endpunkts sind.

OData verwendet URLs zum Anfordern von Informationen aus einer Ressource. Sie erstellen die URL auf eine bestimmte Weise Abfrageoptionen, die Informationen zurückgegeben, die Sie benötigen, verwenden. Eine typische OData-Anforderung sieht wie in der folgenden URL aus:

http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$top=20

In diesem Beispiel für OData-Anforderung ist so strukturiert, dass es Ruft die ersten 20 Zeilen aus einer Tabelle mit dem Namen Tabelle1 in der Arbeitsmappe ProductSales.xlsx der im Ordner "Dokumente" auf dem Server contoso1 gespeichert wird. Die URL verwendet das System Abfrage Option $top, um die Anzahl der zurückzugebenden Zeilen angeben.Betrachtung der URL, können Sie die drei Komponentenstruktur anzeigen: der Dienst Stamm-URI; der Pfad der Ressource; und die Abfrageoptionen.

Stamm-URI-Service

Der erste Teil der URL das Stammverzeichnis Service aufgerufen und bleibt gleich für jede OData-Anforderung, die Sie an eine SharePoint-Server mit Ausnahme der Name des Servers vornehmen. Er enthält den Namen des SharePoint-Servers, auf dem die Arbeitsmappe gespeichert wird, und den Pfad, _vti_bin/ExcelRest.aspx, wie im folgenden Beispiel dargestellt:

http://contoso1/_vti_bin/ExcelRest.aspx

Ressourcenpfad

Der zweite Teil der URL enthält den Pfad zur Excel-Arbeitsmappe und gibt an, dass es sich um eine OData-Anforderung handelt: /Documents/ProductSales.xlsx/OData.

System-Abfrageoptionen

Der dritte Teil der URL wird Abfrageoptionen für die Anforderung. Abfrageoptionen immer beginnen mit einem Dollarzeichen ($) und am Ende des URIS als Abfrageparameter angefügt sind. Die Anforderung in diesem Beispiel gilt für die ersten 20 Zeilen in der Tabelle "Tabelle1": /Table1?$top=20.

System-Abfrageoptionen bieten eine Möglichkeit zum Abrufen von bestimmter Daten aus einer Ressource. Die Excel Services OData-Implementierung unterstützt eine Reihe von Abfrageoptionen für wie im folgenden Abschnitt aufgeführt.

Die Excel Services-Implementierung der OData unterstützt eine Reihe von OData-System-Abfrage Standardoptionen. Diese Abfrageoptionen sind im Wesentlichen Anforderungen OData da Sie die Optionen zum angeben, welche Daten aus einer Ressource abgerufen werden soll. Die folgende Tabelle enthält die Abfrageoptionen System, die derzeit Excel Services-Implementierung von OData unterstützt.

Tabelle 1. OData-Systemabfrageoptionen für Excel Services

Systemabfrageoption Beschreibung
<tableName> Gibt alle Zeilen der durch <tableName> angegebenen Tabelle zurück, wobei <tableName> der Name einer Tabelle in einer Excel-Arbeitsmappe ist, die die abzurufenden Zeilen enthält. Wichtig: Eine OData-Abfrage dieses Formats gibt maximal 500 Zeilen zurück. Jeder 500-Zeilen-Satz entspricht einer Seite. Um die Zeilen auf weiteren Seiten in einer Tabelle abzurufen, die mehr als 500 Zeilen aufweist, verwenden Sie die Abfrageoption $skiptoken (siehe unten). Im folgenden Beispiel werden alle Zeilen bis zur 500. in Tabelle1 in der Arbeitsmappe "ProductSales.xlsx" zurückgegeben.
$metadata Alle verfügbaren Tabellen und den Typ von Informationen für alle Zeilen zurückgegeben in den einzelnen Tabellen in der angegebenen Arbeitsmappe. Das folgende Beispiel gibt die Tabellen und Typinformationen für die Tabellen in der Arbeitsmappe ProductSales.xlsx zurück. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/$metadata
$orderby Gibt die Zeilen in der angegebenen Tabelle, sortiert nach von $orderbyangegebenen Wert zurück. Das folgende Beispiel gibt alle Zeilen aus „Table1“ in der Arbeitsmappe „ProductSales.xlsx“ zurück, sortiert auf Basis der Spalte „Name“. Hinweis: Der Standardwert für $orderby ist „ascending“. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Name
$top Gibt zurück N Zeilen aus der Tabelle, wobei N eine Zahl, die den Wert des $topangegeben. Das folgende Beispiel gibt die ersten 5 Zeilen from Tabelle1, sortiert nach der Spalte Name in der Arbeitsmappe ProductSales.xlsx. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$orderby=Name&$top=5
$skip Überspringt N Zeilen, wobei N den Wert des $skipangegebene Nummer getestet werden, und gibt dann die restlichen Zeilen der Tabelle zurück. Das folgende Beispiel gibt alle verbleibende Zeilen nach der fünften Zeile from Tabelle1 in der Arbeitsmappe ProductSales.xlsx zurück. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skip=5
$skiptoken Der n-te Zeile, wobei N die Ordnungsposition Zeile durch den Wert des $skiptokenangegeben ist, sucht und gibt dann alle verbleibende Zeilen, beginnend bei Zeile N + 1 zurück. Die Auflistung ist nullbasiert, damit die zweite Zeile, beispielsweise durch $skiptoken angegebenen = 1. Das folgende Beispiel gibt alle verbleibende Zeilen nach der zweiten Zeile from Tabelle1 in der Arbeitsmappe ProductSales.xlsx zurück. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=1 Sie können auch die Abfrageoption $skiptoken verwenden, um Zeilen auf Seiten nach der ersten Seite aus einer Tabelle abzurufen, die mehr als 500 Zeilen enthält. Im folgenden Beispiel wird veranschaulicht, die 500th Zeile abgerufen und aus einer Tabelle mit mehr als 500 Zeilen höher. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$skiptoken=499
$filter Gibt die Teilmenge der Zeilen, die den Wert der $filterangegebenen Bedingungen erfüllen. Weitere Informationen zu den Operatoren und einer Reihe von Funktionen, die Sie mit $filter verwenden können, finden Sie in der OData-Dokumentation. Das folgende Beispiel gibt nur die Zeilen, wobei der Wert der Spalte Price größer als 100 ist. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$filter=Price gt 100
$format Das Atom-XML-Format ist der einzige unterstützte Wert und ist die Standardeinstellung für die Abfrageoption $format.
$select Gibt die Entität, die durch $selectangegebenen zurück. Im folgende Beispiel werden die Spalte Name in der Arbeitsmappe ProductSales.xlsx from Tabelle1 markiert. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$select=Name
$inlinecount Gibt die Anzahl der Zeilen in der angegebenen Tabelle zurück. $ inlinecount können nur 1 von 2 der folgenden Werte verwenden.
  • allpages - zurückgegeben Anzahl die für alle Zeilen in der Tabelle.
  • none - umfasst keine Anzahl der Zeilen in der Tabelle.
Im folgende Beispiel werden die Anzahl für die Gesamtanzahl der Zeilen in Tabelle1 in der ProductSales.xlsx Arbeitsmappe zurückgegeben. http://contoso1/_vti_bin/ExcelRest.aspx/Documents/ProductSales.xlsx/OData/Table1?$inlinecount=allpages

Siehe auch