REST-API-Referenz und Beispiele
Im MSDN finden Sie Dokumentationen zur SharePoint 2013-REST-Oberfläche (Representational State Transfer).
Diese Seite enthält Links zu häufig verwendeten REST-Ressourcen die für SharePoint 2013-Entwickler verfügbar sind.
Letzte Änderung: Dienstag, 17. November 2015
Gilt für: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013
Video ansehen: Grundlagen zu SharePoint 2013 REST und OData
Tipp
Der SharePoint Online-REST-Dienst unterstützt die Kombination mehrerer Anforderungen in einem einzelnen Dienstaufruf mithilfe der OData-Abfrageoption $batch. Einzelheiten und Links zu Codebeispielen finden Sie unter Erstellen von Batchanforderungen mit den REST-APIs. Diese Option wird für lokales SharePoint noch nicht unterstützt.
SharePoint 2013 REST-Referenz
Hinweis
Einige der folgenden Links führen zur Dokumentation des entsprechenden JavaScript-Objekts, die den REST-Endpunkt unten auf der Seite anzeigt.
REST-Kernendpunkte
Ressource |
Beschreibung |
---|---|
Steht für eine Auflistung von SP.Change-Objekten. |
|
Stellt eine Auflistung von EventReceiverDefinition-Objekten dar, die zum Aufzählen einer Liste registrierter Ereignisempfänger für Microsoft SharePoint Foundation-Objekte dienen. |
|
Steht für eine Auflistung von SP.Feature-Objekten. |
|
Steht für ein aktiviertes Feature. |
|
Steht für eine Auflistung von SP.RecycleBinItem-Objekten. |
|
Steht für ein Papierkorbelement im Papierkorb einer Website oder einer Websitesammlung. |
|
Stellt regionale Einstellungen dar, die auf dem Server verwendet werden, auf dem Microsoft SharePoint Foundation ausgeführt werden. |
|
Steht für eine Auflistung von Websites in einer Webanwendung (einschließlich einer Website auf oberster Ebene und aller Unterwebsites). |
|
Stellt eine SharePoint-Website dar. |
|
Gibt eine Auflistung von Websitevorlagen zurück. |
|
Gibt eine Websitedefinition oder -vorlage an, die zum Instanziieren einer Website verwendet wird. |
Auf REST-Liste bezogene Endpunkte
Ressource |
Beschreibung |
---|---|
Stellt eine Sammlung von List-Ressourcen dar. |
|
Steht für eine Liste auf einer SharePoint-Website. |
|
Stellt eine Sammlung von ListItem-Ressourcen dar. |
|
Steht für ein Element oder eine Zeile in einer Liste. |
|
Steht für eine Auflistung von Website- oder Listeninhaltstypen. |
|
Steht für den Inhaltstyp einer Website oder Liste. |
|
Stellt eine Sammlung von Field-Ressourcen dar. |
|
Steht für ein Feld in einer Liste auf einer Microsoft SharePoint Foundation-Website. |
|
Steht für eine Auflistung von SP.FieldLink-Objekten, bei denen es sich um Spalten- oder Feldverweise in einem Inhaltstyp handelt.. |
|
Gibt einen Verweis auf ein Feld oder eine Felddefinition für einen Inhaltstyp an. |
|
Steht für eine Auflistung von SP.Form-Objekten für eine Liste. |
|
Ein Formular bietet eine Anzeige- und Bearbeitungsschnittstelle für ein einzelnes Listenelement. |
|
Steht für eine Auflistung von SP.ListTemplate-Objekten. |
|
Gibt eine Listenvorlage an. |
|
Steht für eine Auflistung von SP.RelatedField-Objekten, die Eigenschaften von Beziehungsnachschlagefeldern speichern. |
|
Gibt eine Beziehung zu einem Nachschlagefeld an. |
|
Stellt eine Sammlung von View-Ressourcen dar. |
|
Gibt eine Listenansicht an. |
|
Steht für eine Auflistung von Feldern in einer Listenansicht. |
REST-Endpunkte für Dateien und Ordner
Ressource |
Beschreibung |
---|---|
Stellt eine Sammlung von File-Ressourcen dar. |
|
Steht für eine Datei auf einer SharePoint-Website, bei der es sich um eine Webpartseite, um ein Element in einer Dokumentbibliothek oder um eine Datei in einem Ordner handeln kann. |
|
Stellt eine Sammlung von FileVersion-Ressourcen dar. |
|
Stellt eine Version einer File-Ressource dar. |
|
Stellt eine Sammlung von Folder-Ressourcen dar. |
|
Steht für einen Ordner auf einer SharePoint-Website. |
REST-Endpunkte für Benutzer und Gruppen
Ressource |
Beschreibung |
---|---|
Stellt eine Sammlung von Group-Ressourcen dar. |
|
Steht für eine Gruppe auf einer Microsoft SharePoint Foundation-Website. |
|
Stellt eine Sammlung von RoleAssignment-Ressourcen dar, die alle Rollenzuweisungen für ein sicherungsfähiges Objekt festlegt. |
|
Definiert die Rollenzuweisungen für das sicherungsfähige Objekt für einen Benutzer oder eine Gruppe auf der Website, in der Liste oder im Listenelement. |
|
Stellt die Sammlung von RoleDefinition-Ressourcen dar, die die Rollendefinitionen definieren, die zum Verwenden innerhalb der Website verfügbar sind. |
|
Definiert eine einzelne Rollendefinition einschließlich Name, Beschreibung und Rechtesatz. |
|
Definiert die an ein Rollenzuweisungsobjekt gebundenen Rollendefinitionen. |
|
Stellt eine Sammlung von User-Ressourcen dar. |
|
Stellt einen Benutzer in Microsoft SharePoint Foundation dar. |
|
Stellt eine Sammlung von UserCustomAction-Ressourcen dar. |
|
Steht für eine benutzerdefinierte Aktion in Verbindung mit einer SharePoint-Liste, -Website oder -Unterwebsite. |
Komplexe REST-Typen
Ressource |
Beschreibung |
---|---|
Stellt eine App-Lizenz für den angegebenen Benutzer für die angegebene SharePoint-Add-In dar. |
|
Die einem App-Prinzipal zugeordnete Konfiguration. |
|
Stellt einen Verweis auf die Anmeldedaten für einen App-Prinzipal dar. |
|
Stellt die Basisberechtigungen für eine Rollendefinition dar. |
|
Gibt eine CAML (Collaborative Application Markup Language)-Abfrage für eine Liste oder für verknüpfte Listen an. |
|
Stellt den Eingabeparameter der GetListItemChangesSinceToken-Methode dar. |
|
Definiert eine Abfrage, die für das Änderungsprotokoll ausgeführt wird. |
|
Steht für den eindeutigen sequenziellen Ort einer Änderung innerhalb des Änderungsprotokolls. |
|
Gibt Eigenschaften an, die als Parameter zum Initialisieren eines neuen Inhaltstyps verwendet werden. |
|
Steht für den Inhaltstypbezeichner (ID) eines Inhaltstyps. |
|
Die Kontextinformationen für eine Website. |
|
Stellt Informationen zu einer Dokumentbibliothek dar. |
|
Gibt Informationen zur Erstellung von Ereignisempfängern an. |
|
Stellt das Objekt dar, das alle zum Erstellen eines neuen externen App-Prinzipals verwendeten Parameter einschließt. |
|
Steht für den Wert des berechneten Felds eines Listenelements, wenn es sich bei dem Wert des Felds um einen Berechnungsfehler (beispielsweise um eine Teilung durch null oder um einen Überlauf) handelt. |
|
Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können. |
|
Gibt die Höhen-, Breitengrad-, Längengrad- und Messwerte für ein Geolocation-Feld an. |
|
Gibt den Wert einer Suche nach einem Feld innerhalb eines Listenelements an. |
|
Steht für eine bestimmte untergeordnete Frage und Antwort innerhalb eines Bewertungsskalafelds eines Listenelements. |
|
Gibt den Link- und den Beschreibungswert für "FieldURL" an. |
|
Steht für den Wert eines Benutzerfelds für ein Listenelement. |
|
Stellt Eigenschaften dar, die festgelegt werden können, wenn eine Datei mithilfe der FileCollection.Add-Methode erstellt wird. |
|
Ein Objekt zum Vereinfachen der Erstellung einer websiteübergreifenden Gruppe. |
|
Stellt ein Verzeichnis der Schlüssel- und Wert-Paare dar. |
|
Stellt eine natürliche Sprache dar, die im Kontext von Microsoft SharePoint Foundation verwendet wird. |
|
Steht für Informationen im Zusammenhang mit einer Verbindung mit einer externen Datenquelle. |
|
Die Ausnahme, die ausgelöst wird, wenn die Überprüfung der Daten für ein Listenfeld oder -element nicht erfolgreich ist. |
|
Beschreibt einen spezifischen Überprüfungsfehler beim Einfügen oder Aktualisieren eines Listenelements. |
|
Gibt die erforderlichen Informationen zum Abrufen der nächsten Seite mit Daten für eine Listenansicht an. |
|
Gibt die Eigenschaften des neuen Listenelements an. |
|
Stellt die Eigenschaften eines Listenelementfelds und dessen Wert dar. |
|
Stellt einen Navigationsknoten in der Navigationshierarchie dar. Eine Navigationshierarchie ist eine Baumstruktur der Navigationsknoten. |
|
Stellt den Menüstatus des standardmäßigen SiteMapProvider ("SPSiteMapProvider") dar, bei dem die Sicherung beim Stammknoten der Website mit einer Tiefe von 10 Ebenen beginnt. |
|
Beschreibt einen neuen zu erstellenden Navigationsknoten. |
|
Stellt die Parameter zum Rendern von Listendaten wie z. B. einer JavaScript Object Notation (JSON)-Zeichenfolge bereit. |
|
Enthält Eigenschaften, die als Parameter zum Initialisieren einer Rollendefinition verwendet werden. |
|
Stellt eine Zeile in einer Datentabelle dar. |
|
Stellt eine Datentabelle dar. |
|
Stellt Informationen über eine Zeitzone dar. |
|
Stellt die Informationen zum Upgrade der Website dar. |
|
Gibt Felder an, die für den Zugriff auf Informationen zur Websitesammlungsverwendung verwendet werden. |
|
Parameter zum Einladen eines Benutzers. |
|
Stellt Informationen zum eindeutigen Bezeichner eines Identitätsanbieters dar. |
|
Gibt die Eigenschaften an, die zum Erstellen einer neuen Listenansicht verwendet werden. |
|
Gibt die Eigenschaften einer neuen Website an. |
|
Stellt Metadaten zur Websiteerstellung dar. |
|
Gibt die Daten vom Aufrufer an, die für die Ausführung der ausgehenden Webanforderung benötigt werden. |
|
Enthält eine Kopie der Antwort des Drittanbieterdiensts. |
|
Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können. |
SharePoint 2013 – REST-Übersichten
Ressource |
Beschreibung |
---|---|
Erhalten Sie grundlegende Informationen zum Verwenden des SharePoint 2013 REST-Diensts zum Zugreifen und Aktualisieren von SharePoint-Daten mit den REST- und OData-Webprotokollstandards. |
|
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint 2013-REST-Endpunkten |
Erfahren Sie, wie Sie grundlegende CRUD-Vorgänge mit der SharePoint 2013-REST-Schnittstelle durchführen. |
Fügen Sie Client- und mobilen Anwendungen mithilfe des Search-REST-Diensts in SharePoint Server 2013 und jeder Technologie, die REST-Webanfragen unterstützt, Suchfunktionen hinzu. |
|
Erfahren Sie mehr über SharePoint 2013-REST-Endpunkte für PeopleManager, ProfileLoader, UserProfile und zugehörige Ressourcen. |
|
Informieren Sie sich über SharePoint 2013-REST-Endpunkte für feedbezogene Aufgaben. |
|
REST-API-Referenz zum Folgen von Personen und Inhalten für SharePoint 2013 |
Informieren Sie sich über SharePoint 2013-REST-Endpunkte zum Folgen von Personen und Inhalten. |
SharePoint 2013 REST-Codebeispiele
Ressource |
Beschreibung |
---|---|
Erfahren Sie, wie Sie eine vom Anbieter gehostete grundlegende "Hello World" SharePoint-Add-In erstellen, die die SharePoint REST-Schnittstelle zum Lesen von Informationen zu einer SharePoint 2013-Website über eine Remote-Webanwendung verwendet. |
|
SharePoint 2013: Verwenden des REST-Diensts aus einer App für SharePoint |
Informationen zum Übermitteln einer Suchanfrage anSuche in SharePoint 2013 aus einer SharePoint-Add-In. |
SharePoint 2013: Erstellen von REST-Abfragen und Verwenden von REST zum Durchlaufen einer Website |
Informationen zum Verwenden der SharePoint-REST-APIs zum Durchlaufen einer SharePoint 2013-Website und zum Erstellen einer App, mit der Abfragen für die Durchführung grundlegender Datenvorgänge auf grundlegenden SharePoint-Entitäten erstellt werden, die auf REST-Endpunkten verfügbar gemacht werden. |
SharePoint 2013: Durchführen grundlegender Datenzugriffsvorgänge mithilfe von REST in Apps |
Informationen zur Verwendung der SharePoint-REST-APIs zum Durchführen grundlegender Datenzugriffsvorgänge für SharePoint 2013-Listen und -Listenelemente. |
SharePoint 2013: Durchführen grundlegender Datenvorgänge für Dateien und Ordner mithilfe von REST |
Ein Codebeispiel, bei dem REST und die domänenübergreifende SharePointJavaScript-Bibliothek zum Durchführen grundlegender Vorgänge für Dokumentbibliotheken und Dateien verwendet wird. |
SharePoint 2013: Durchführen von Aufrufen vom Typ "Nur-App-Richtlinie" in einer Remote-App (REST) |
Informationen zur Verwendung des AllowAppOnlyPolicy-Attributs mit REST und OAuth zum Durchführen eines Rückrufs an SharePoint 2013. |
Informationen zur Erstellung einer SharePoint-Add-In, von der REST-URLs zum Abfragen und Ändern von Daten in einer externen Liste verwendet werden. |
|
SharePoint 2013: Verwenden des Chromsteuerelements und der domänenübergreifenden Bibliothek (REST) |
Informationen zur Einbindung einer Remotewebsite, auf der das Chromsteuerelement gehostet wird und mit der mithilfe der domänenübergreifenden Bibliothek und REST in SharePoint 2013 Informationen aus dem Hostweb abgerufen werden. |
SharePoint 2013: Abrufen von Listenelementen mithilfe der domänenübergreifenden Bibliothek (REST) |
Informationen zur Verwendung der domänenübergreifenden Bibliothek in SharePoint-Add-Ins zum Lesen von Elementen in einer Liste, die im App-Web gehostet wird. |
SharePoint 2013: Abrufen des Hostwebtitels mithilfe der domänenübergreifenden Bibliothek (REST) |
Informationen zur Verwendung der domänenübergreifenden Bibliothek in SharePoint 2013 zum Lesen der title-Eigenschaft des Hostwebs. |
Festlegen von benutzerdefinierten Berechtigungen in einer Liste mit der REST-Schnittstelle |
Informationen zum Definieren von benutzerdefinierten abgestimmten Berechtigungen in einer SharePoint-Liste mit der REST-Schnittstelle und JavaScript. |
Zusätzliche Ressourcen
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint 2013-REST-Endpunkten
Durchführen von REST-Aufrufen mit C# und JavaScript für SharePoint 2013
Durchführen von REST-Aufrufen mit C# und JavaScript für SharePoint 2013 Demo
Sicherer Datenzugriff und Clientobjektmodelle für SharePoint-Add-Ins