REST-API-Referenz und Beispiele

  • Artikel

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

SP. ChangeCollection Object (sp.js)

Steht für eine Auflistung von SP.Change-Objekten.

SP. EventReceiverDefinitionCollection Object (sp.js)

Stellt eine Auflistung von EventReceiverDefinition-Objekten dar, die zum Aufzählen einer Liste registrierter Ereignisempfänger für Microsoft SharePoint Foundation-Objekte dienen.

SP. EventReceiverDefinition Object (sp.js)

SP. FeatureCollection Object (sp.js)

Steht für eine Auflistung von SP.Feature-Objekten.

SP. Feature Object (sp.js)

Steht für ein aktiviertes Feature.

SP. RecycleBinItemCollection Object (sp.js)

Steht für eine Auflistung von SP.RecycleBinItem-Objekten.

SP. RecycleBinItem Object (sp.js)

Steht für ein Papierkorbelement im Papierkorb einer Website oder einer Websitesammlung.

SP. RegionalSettings Object (sp.js)

Stellt regionale Einstellungen dar, die auf dem Server verwendet werden, auf dem Microsoft SharePoint Foundation ausgeführt werden.

SP. Website Object (sp.js)

Steht für eine Auflistung von Websites in einer Webanwendung (einschließlich einer Website auf oberster Ebene und aller Unterwebsites).

SP. TimeZoneCollection Object (sp.js)

SP. TimeZone-Objekt (sp.js)

Web

Stellt eine SharePoint-Website dar.

SP. WebTemplateCollection Object (sp.js)

Gibt eine Auflistung von Websitevorlagen zurück.

SP. WebTemplate Object (sp.js)

Gibt eine Websitedefinition oder -vorlage an, die zum Instanziieren einer Website verwendet wird.

Auf REST-Liste bezogene Endpunkte

Ressource

Beschreibung

ListCollection

Stellt eine Sammlung von List-Ressourcen dar.

List

Steht für eine Liste auf einer SharePoint-Website.

ListItemCollection

Stellt eine Sammlung von ListItem-Ressourcen dar.

ListItem

Steht für ein Element oder eine Zeile in einer Liste.

SP. ContentTypeCollection Object (sp.js)

Steht für eine Auflistung von Website- oder Listeninhaltstypen.

SP. ContentType Object (sp.js)

Steht für den Inhaltstyp einer Website oder Liste.

FieldCollection

Stellt eine Sammlung von Field-Ressourcen dar.

Field

Steht für ein Feld in einer Liste auf einer Microsoft SharePoint Foundation-Website.

SP. FieldLinkCollection Object (sp.js)

Steht für eine Auflistung von SP.FieldLink-Objekten, bei denen es sich um Spalten- oder Feldverweise in einem Inhaltstyp handelt..

SP. FieldLink Object (sp.js)

Gibt einen Verweis auf ein Feld oder eine Felddefinition für einen Inhaltstyp an.

SP. FormCollection Object (sp.js)

Steht für eine Auflistung von SP.Form-Objekten für eine Liste.

SP. Form-Objekt (sp.js)

Ein Formular bietet eine Anzeige- und Bearbeitungsschnittstelle für ein einzelnes Listenelement.

SP.InformationRightsManagementSettings-Objekts (sp.js)

SP. ListTemplateCollection Object (sp.js)

Steht für eine Auflistung von SP.ListTemplate-Objekten.

SP. ListTemplate-Objekt (sp.js)

Gibt eine Listenvorlage an.

SP. RelatedFieldCollection Object (sp.js)

Steht für eine Auflistung von SP.RelatedField-Objekten, die Eigenschaften von Beziehungsnachschlagefeldern speichern.

SP. RelatedField Object (sp.js)

Gibt eine Beziehung zu einem Nachschlagefeld an.

ViewCollection

Stellt eine Sammlung von View-Ressourcen dar.

View

Gibt eine Listenansicht an.

ViewFieldCollection

Steht für eine Auflistung von Feldern in einer Listenansicht.

REST-Endpunkte für Dateien und Ordner

Ressource

Beschreibung

FileCollection

Stellt eine Sammlung von File-Ressourcen dar.

File

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.

FileVersionCollection

Stellt eine Sammlung von FileVersion-Ressourcen dar.

FileVersion

Stellt eine Version einer File-Ressource dar.

FolderCollection

Stellt eine Sammlung von Folder-Ressourcen dar.

Folder

Steht für einen Ordner auf einer SharePoint-Website.

REST-Endpunkte für Benutzer und Gruppen

Ressource

Beschreibung

GroupCollection

Stellt eine Sammlung von Group-Ressourcen dar.

Group

Steht für eine Gruppe auf einer Microsoft SharePoint Foundation-Website.

RoleAssignmentCollection

Stellt eine Sammlung von RoleAssignment-Ressourcen dar, die alle Rollenzuweisungen für ein sicherungsfähiges Objekt festlegt.

RoleAssignment

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.

RoleDefinitionCollection

Stellt die Sammlung von RoleDefinition-Ressourcen dar, die die Rollendefinitionen definieren, die zum Verwenden innerhalb der Website verfügbar sind.

RoleDefinition

Definiert eine einzelne Rollendefinition einschließlich Name, Beschreibung und Rechtesatz.

RoleDefinitionBindingCollection

Definiert die an ein Rollenzuweisungsobjekt gebundenen Rollendefinitionen.

UserCollection

Stellt eine Sammlung von User-Ressourcen dar.

User

Stellt einen Benutzer in Microsoft SharePoint Foundation dar.

UserCustomActionCollection

Stellt eine Sammlung von UserCustomAction-Ressourcen dar.

UserCustomAction

Steht für eine benutzerdefinierte Aktion in Verbindung mit einer SharePoint-Liste, -Website oder -Unterwebsite.

Komplexe REST-Typen

Ressource

Beschreibung

AppLicense

Stellt eine App-Lizenz für den angegebenen Benutzer für die angegebene SharePoint-Add-In dar.

AppLicenseCollection

AppPrincipalConfiguration

Die einem App-Prinzipal zugeordnete Konfiguration.

AppPrincipalCredentialReference

Stellt einen Verweis auf die Anmeldedaten für einen App-Prinzipal dar.

BasePermissions

Stellt die Basisberechtigungen für eine Rollendefinition dar.

CamlQuery

Gibt eine CAML (Collaborative Application Markup Language)-Abfrage für eine Liste oder für verknüpfte Listen an.

ChangeLogItemQuery

Stellt den Eingabeparameter der GetListItemChangesSinceToken-Methode dar.

ChangeQuery

Definiert eine Abfrage, die für das Änderungsprotokoll ausgeführt wird.

ChangeToken

Steht für den eindeutigen sequenziellen Ort einer Änderung innerhalb des Änderungsprotokolls.

ContentTypeCreationInformation

Gibt Eigenschaften an, die als Parameter zum Initialisieren eines neuen Inhaltstyps verwendet werden.

ContentTypeId

Steht für den Inhaltstypbezeichner (ID) eines Inhaltstyps.

ContextWebInformation

Die Kontextinformationen für eine Website.

DocumentLibraryInformation

Stellt Informationen zu einer Dokumentbibliothek dar.

EventReceiverDefinitionCreationInformation

Gibt Informationen zur Erstellung von Ereignisempfängern an.

ExternalAppPrincipalCreationParameters

Stellt das Objekt dar, das alle zum Erstellen eines neuen externen App-Prinzipals verwendeten Parameter einschließt.

FieldCalculatedErrorValue

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.

FieldCreationInformation

Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können.

FieldGeolocationValue

Gibt die Höhen-, Breitengrad-, Längengrad- und Messwerte für ein Geolocation-Feld an.

FieldLookupValue

Gibt den Wert einer Suche nach einem Feld innerhalb eines Listenelements an.

FieldRatingScaleQuestionAnswer

Steht für eine bestimmte untergeordnete Frage und Antwort innerhalb eines Bewertungsskalafelds eines Listenelements.

FieldUrlValue

Gibt den Link- und den Beschreibungswert für "FieldURL" an.

FieldUserValue

Steht für den Wert eines Benutzerfelds für ein Listenelement.

FileCreationInformation

Stellt Eigenschaften dar, die festgelegt werden können, wenn eine Datei mithilfe der FileCollection.Add-Methode erstellt wird.

GroupCreationInformation

Ein Objekt zum Vereinfachen der Erstellung einer websiteübergreifenden Gruppe.

KeyValue

Stellt ein Verzeichnis der Schlüssel- und Wert-Paare dar.

Language

Stellt eine natürliche Sprache dar, die im Kontext von Microsoft SharePoint Foundation verwendet wird.

ListDataSource

Steht für Informationen im Zusammenhang mit einer Verbindung mit einer externen Datenquelle.

ListDataValidationExceptionValue

Die Ausnahme, die ausgelöst wird, wenn die Überprüfung der Daten für ein Listenfeld oder -element nicht erfolgreich ist.

ListDataValidationFailure

Beschreibt einen spezifischen Überprüfungsfehler beim Einfügen oder Aktualisieren eines Listenelements.

ListItemCollectionPosition

Gibt die erforderlichen Informationen zum Abrufen der nächsten Seite mit Daten für eine Listenansicht an.

ListItemCreationInformation

Gibt die Eigenschaften des neuen Listenelements an.

ListItemFormUpdateValue

Stellt die Eigenschaften eines Listenelementfelds und dessen Wert dar.

MenuNode

Stellt einen Navigationsknoten in der Navigationshierarchie dar. Eine Navigationshierarchie ist eine Baumstruktur der Navigationsknoten.

MenuState

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.

NavigationNodeCreationInformation

Beschreibt einen neuen zu erstellenden Navigationsknoten.

RelatedItem

RenderListDataParameters

Stellt die Parameter zum Rendern von Listendaten wie z. B. einer JavaScript Object Notation (JSON)-Zeichenfolge bereit.

RoleDefinitionCreationInformation

Enthält Eigenschaften, die als Parameter zum Initialisieren einer Rollendefinition verwendet werden.

SimpleDataRow

Stellt eine Zeile in einer Datentabelle dar.

SimpleDataTable

Stellt eine Datentabelle dar.

TimeZoneInformation

Stellt Informationen über eine Zeitzone dar.

UpgradeInfo

Stellt die Informationen zum Upgrade der Website dar.

UsageInfo

Gibt Felder an, die für den Zugriff auf Informationen zur Websitesammlungsverwendung verwendet werden.

UserCreationInformation

Parameter zum Einladen eines Benutzers.

UserIdInfo

Stellt Informationen zum eindeutigen Bezeichner eines Identitätsanbieters dar.

ViewCreationInformation

Gibt die Eigenschaften an, die zum Erstellen einer neuen Listenansicht verwendet werden.

WebCreationInformation

Gibt die Eigenschaften einer neuen Website an.

WebInfoCreationInformation

Stellt Metadaten zur Websiteerstellung dar.

WebRequestInfo

Gibt die Daten vom Aufrufer an, die für die Ausführung der ausgehenden Webanforderung benötigt werden.

WebResponseInfo

Enthält eine Kopie der Antwort des Drittanbieterdiensts.

XmlSchemaFieldCreationInformation

Stellt die Eigenschaften dar, die beim Erstellen eines Felds festgelegt werden können.

SharePoint 2013 – REST-Übersichten

Ressource

Beschreibung

Einführung in den SharePoint 2013 REST-Dienst

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.

Übersicht über die REST-API der SharePoint-Suche

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.

Benutzerprofile – REST-API-Referenz

Erfahren Sie mehr über SharePoint 2013-REST-Endpunkte für PeopleManager, ProfileLoader, UserProfile und zugehörige Ressourcen.

REST-API-Referenz für sozialen Feed für SharePoint 2013

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

SharePoint 2013: Hello World-Remote-App mit REST

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.

SharePoint 2013: Zugreifen auf externe Listen mit REST

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