REST-API-Referenz für SharePoint 2013
Erhalten Sie Informationen über die REST-Oberfläche (Representational State Transfer) für die SharePoint 2013-Entwicklung.
**Letzte Änderung:**Montag, 9. März 2015
**Gilt für:**apps for SharePoint | SharePoint Online | SharePoint Server 2013
SharePoint-Lösungen und -Apps, die Sie für lokale Umgebungen entwickeln, können die REST-Oberfläche für die Interaktion mit SharePoint-Daten verwenden. REST-basierte Apps müssen nicht auf Assemblys oder Bibliotheken verweisen. Sie können diese erstellen, indem Sie eine Technologie verwenden, die HTTP-Webanforderungen unterstützt.
In lokalen Umgebungen bereitgestellte SharePoint-Add-Ins folgen demselben Muster wie Apps, die in Office 365-Umgebungen bereitgestellt werden. SharePoint-Lösungen verhalten sich ähnlich wie von SharePoint gehostete Apps – sie werden innerhalb der Firewall ausgeführt. Daher sind die REST-Aufrufe authentifiziert, die Anmeldeinformationen des aktuellen Benutzers zu verwenden und den Formulardigestwert aus dem __REQUESTDIGEST-Seitensteuerelement abzurufen (Beispiel: $("#__REQUESTDIGEST").val()).
Hinweis
Andere clientseitige APIs haben Vorteile im Vergleich zu REST. So werden REST-Aufrufe beispielsweise immer asynchron gesendet. Weitere Informationen für die Entscheidung, ob die REST-Schnittstelle die für Sie am besten geeignete Option ist, finden Sie unter Auswählen des richtigen API-Satzes in SharePoint 2013.
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.
Häufig verwendete REST-Ressourcen
Hinweis
Über einige der folgenden Links können Sie die Dokumentation des entsprechenden JavaScript-Objekts öffnen, das unten auf der Seite den REST-Endpunkt anzeigt.
REST-Kern-Ressourcen
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 Ressourcen
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-Ressourcen 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-Ressourcen 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. |
SharePoint 2013 – REST-Übersichten
Ressource |
Beschreibung |
|---|---|
Erlernen Sie die Grundlagen zum Verwenden des SharePoint 2013-REST-Diensts zum Zugreifen auf und Aktualisieren von SharePoint-Daten mithilfe der 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. |
|
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. |