Grundlegendes zum SharePoint REST-DienstGet to know the SharePoint REST service

In SharePoint wird der REST (Representational State Transfer)-Dienst eingeführt, der mit den bestehenden SharePoint Clientobjektmodellen vergleichbar ist.SharePoint introduces a Representational State Transfer (REST) service that is comparable to the existing SharePoint client object models. Entwickler können nun über eine beliebige Technologie, die REST-Webanforderungen unterstützt, remote mit SharePoint-Daten interagieren.Now, developers can interact remotely with SharePoint data by using any technology that supports REST web requests. Dies bedeutet, dass Entwickler mithilfe von REST-Webtechnologien und der standardmäßigen Open Data Protocol(OData)-Syntax über SharePoint-Add-Ins, -Lösungen und -Clientanwendungen CRUD-Vorgänge (Erstellen, Lesen, Aktualisieren und Löschen) ausführen können.This means that developers can perform Create, Read, Update, and Delete (CRUD) operations from their SharePoint Add-ins, solutions, and client applications, using REST web technologies and standard Open Data Protocol (OData) syntax.

VoraussetzungenPrerequisites

In diesem Thema wird davon ausgegangen, dass Sie über grundlegende Kenntnisse in REST und im Erstellen von REST-Anfragen verfügen.This topic assumes you have a basic familiarity with REST and how to construct REST requests.

Funktionsweise des SharePoint REST-DienstsHow the SharePoint REST service works

In SharePoint wurde die Möglichkeit hinzugefügt, mithilfe von REST remote mit SharePoint-Websites zu interagieren.SharePoint adds the ability for you to remotely interact with SharePoint sites by using REST. Nun können Sie mit jeder Technologie, die standardmäßige REST-Funktionen unterstützt, direkt mit SharePoint-Objekten interagieren.Now you can interact directly with SharePoint objects by using any technology that supports standard REST capabilities.

Um mithilfe von REST auf SharePoint-Ressourcen zuzugreifen, erstellen Sie mithilfe des OData-Standards (Open Data Protocol), das der gewünschten Clientobjektmodell-API entspricht, eine RESTful-HTTP-Anforderung. Beispiel:To access SharePoint resources using REST, construct a RESTful HTTP request by using the OData standard, which corresponds to the desired client object model API. Beispiel:For example:

Clientobjektmodell-Methode:Client object model method:
List.GetByTitle(listname)

REST-Endpunkt:REST endpoint:
http://server/site/_api/lists/getbytitle('listname')

Der Webdienst „client.svc“ in SharePoint verarbeitet die HTTP-Anforderung und liefert die entsprechende Antwort im Format Atom oder JavaScript Object Notation (JSON).The client.svc web service in SharePoint handles the HTTP request, and serves the appropriate response in either Atom or JavaScript Object Notation (JSON) format. Die Clientanwendung muss diese Antwort dann analysieren.Your client application must then parse that response. Die folgende Abbildung zeigt eine allgemeine Übersicht über die SharePoint-REST-Architektur.The following figure shows a high-level view of the SharePoint REST architecture.

Architektur des SharePoint REST-DienstsSharePoint REST service architecture

Architektur des SharePoint REST-Diensts

Aufgrund ihrer Funktionen und Benutzerfreundlichkeit bleiben Clientobjektmodelle die erste Entwicklungsoption für die Kommunikation mit SharePoint-Websites mithilfe von verwaltetem .NET Framework-Code, Silverlight oder JavaScript.Because of the functionality and ease of use that client object models provide, they remain the primary development option for communicating with SharePoint sites by using .NET Framework managed code, Silverlight, or JavaScript.

Verwenden von HTTP-Befehlen im SharePoint REST-DienstUse HTTP commands with the SharePoint REST service

Um die in SharePoint integrierten REST-Funktionen zu verwenden, erstellen Sie mithilfe des OData-Standards eine RESTful-HTTP-Anforderung, die der Clientobjektmodell-API entspricht, die Sie verwenden möchten.To use the REST capabilities that are built into SharePoint, you construct a RESTful HTTP request by using the OData standard, which corresponds to the client object model API you want to use. Der Webdienst „client.svc“ verarbeitet die HTTP-Anforderung und liefert die entsprechende Antwort im Format Atom oder JSON.The client.svc web service handles the HTTP request and serves the appropriate response in either Atom or JSON format. Die Clientanwendung muss diese Antwort dann analysieren.The client application must then parse that response.

Die Endpunkte im SharePoint REST-Dienst entsprechen den Typen und Membern in den SharePoint-Clientobjektmodellen. Mithilfe von HTTP-Anforderungen können Sie diese REST-Endpunkte verwenden, um typische CRUD-Vorgänge in SharePoint-Entitäten, z. B. Listen und Websites, auszuführen.The endpoints in the SharePoint REST service correspond to the types and members in the SharePoint client object models. By using HTTP requests, you can use these REST endpoints to perform typical CRUD operations against SharePoint entities, such as lists and sites.

Wenn Sie dies an einem Endpunkt ausführen möchtenIf you want to do this to an endpoint Verwenden Sie diese HTTP-AnforderungUse this HTTP request Zu berücksichtigenKeep in mind
Lesen einer RessourceRead a resource GETGET
Erstellen oder Aktualisieren einer RessourceCreate or update a resource POSTPOST - Verwenden Sie POST, um Entitäten wie Listen und Websites zu erstellen.- Use POST to create entities such as lists and sites.
- Der SharePoint-REST-Dienst unterstützt das Senden von POST-Befehlen, die Objektdefinitionen enthalten, an Endpunkte, die Sammlungen darstellen.- The SharePoint REST service supports sending POST commands that include object definitions to endpoints that represent collections.
- Bei POST-Vorgängen werden alle Eigenschaften, die nicht erforderlich sind, auf ihre Standardwerte festgelegt.- For POST operations, any properties that are not required are set to their default values.
- Wenn Sie versuchen, eine schreibgeschützte Eigenschaft als Teil des POST-Vorgangs festzulegen, gibt der Dienst eine Ausnahme zurück.- If you attempt to set a read-only property as part of a POST operation, the service returns an exception.
Aktualisieren oder Hinzufügen einer RessourceUpdate or insert a resource PUTPUT - Verwenden Sie PUT- und MERGE-Vorgänge, um vorhandene SharePoint-Objekte zu aktualisieren.- Use PUT and MERGE operations to update existing SharePoint objects.
- Jeder Dienstendpunkt, der einen set-Vorgang einer Objekteigenschaft darstellt, unterstützt sowohl PUT- als auch MERGE-Anforderungen.- Any service endpoint that represents an object property set operation supports both PUT requests and MERGE requests.
- Bei MERGE-Vorgängen ist das Festlegen von Eigenschaften optional; Eigenschaften, die Sie nicht explizit festlegen, behalten ihre aktuelle Eigenschaft.- For MERGE requests, setting properties is optional; any properties that you do not explicitly set retain their current property.
- Wenn Sie bei PUT-Befehlen nicht alle erforderlichen Eigenschaften in Objektaktualisierungen angeben, gibt der REST-Dienst eine Ausnahme zurück.- For PUT requests, if you do not specify all required properties in object updates, the REST service returns an exception.
- Zusätzlich werden alle nicht explizit festgelegten Eigenschaften auf ihre Standardeigenschaften festgelegt.- In addition, any optional properties you do not explicitly set are set to their default properties.
Löschen einer RessourceDelete a resource DELETEDELETE - Verwenden Sie den HTTP-DELETE-Befehl für die spezifische Endpunk-URL, um das von diesem Endpunkt dargestellte SharePoint-Objekt zu löschen.- Use the HTTP DELETE command against the specific endpoint URL to delete the SharePoint object represented by that endpoint.
- Bei wiederverwendbaren Objekten, z. B. Listen, Dateien und Listenelementen, führt dies zu einer Recycle-Operation.- In the case of recyclable objects, such as lists, files, and list items, this results in a Recycle operation.


Erstellen von REST URLs für den Zugriff auf SharePoint-RessourcenConstruct REST URLs to access SharePoint resources

Wann immer möglich, bildet die URI für diese REST-Endpunkte die API-Signatur der Ressource im SharePoint-Clientobjektmodell streng nach. Die zentralen Einstiegspunkte für den REST-Service stellen die Websitesammlung und die Website des angegebenen Kontexts dar.Whenever possible, the URI for these REST endpoints closely mimics the API signature of the resource in the SharePoint client object model. The main entry points for the REST service represent the site collection and site of the specified context.

Gehen Sie folgendermaßen vor, um auf eine bestimmte Websitesammlung zuzugreifen:To access a specific site collection, use the following construction:

http://server/site/_api/site

Gehen Sie folgendermaßen vor, um auf eine bestimmte Website zuzugreifen:To access a specific site, use the following construction:

http://server/site/_api/web

Dabei steht server für den Namen des Servers und site für den Namen der oder den Pfad zur entsprechenden Website.In each case, server represents the name of the server, and site represents the name of, or path to, the specific site.

Ausgehend davon können Sie dann spezifischere REST-URIs erstellen, indem Sie das Objektmodell mithilfe der durch Schrägstrich (/) getrennten Namen der APIs aus dem Clientobjektmodell durchsuchen.From this starting point, you can then construct more specific REST URIs by "walking" the object model, using the names of the APIs from the client object model separated by a forward slash (/).

Diese Syntax gilt nicht für REST-APIs des SocialFeedManager oder SocialFollowingManager.This syntax doesn't apply to the SocialFeedManager or SocialFollowingManager REST APIs. Weitere Informationen finden Sie unter:For more information, see:

Unter Ermitteln von URIs von SharePoint-REST-Dienstendpunkten finden Sie Richtlinien zur Ermittlung von URIs von SharePoint-REST-Dienstendpunkten mithilfe der Signatur der entsprechenden Clientobjektmodell-APIs.For more guidelines for determining SharePoint REST endpoint URIs from the signature of the corresponding client object model APIs, see Determine SharePoint REST service endpoint URIs.

Beispiele für SharePoint REST-EndpunkteSharePoint REST endpoint examples

Die folgende Tabelle enthält Beispiele für typische REST-Endpunkt-URLs, um Ihnen den Einstieg in die Arbeit mit SharePoint-Daten zu erleichtern.The following table contains typical REST endpoint URL examples to get you started working with SharePoint data. Stellen Sie den in der Tabelle gezeigten URL-Fragmenten http://server/site/_api/ voran, um eine vollständig qualifizierte REST-URL zu konstruieren.Prepend http://server/site/_api/ to the URL fragments shown in the table to construct a fully qualified REST URL. Wenn für POST-Befehle erforderlich, enthält die Tabelle Beispieldaten, die Sie im Hauptteil der HTTP-Anforderung übergeben müssen, um das angegebene SharePoint-Element zu erstellen.Where necessary for POST commands, the table contains sample data you must pass in the HTTP request body to create the specified SharePoint item. Elemente in Kursivschrift stellen Variablen dar, die Sie durch Ihre Werte ersetzen müssen.Items in quotes represent variables that you must replace with your values.


BeschreibungDescription URL-EndpunktURL endpoint HTTP-MethodeHTTP method TextkörperBody content
Ruft den Titel einer Liste abRetrieves the title of a list web/title GETGET Not applicable
Ruft alle Listen auf einer WebsiteRetrieves all lists on a site lists GETGET Nicht zutreffendNot applicable
Ruft die Metadaten einer einzelnen Liste abRetrieves a single list's metadata lists/getbytitle('listname') GETGET Not applicable
Ruft Elemente in einer Liste abRetrieves items within a list lists/getbytitle('listname')/items GETGET Nicht zutreffendNot applicable
Ruft eine bestimmte Eigenschaft eines Dokuments ab.Retrieves a specific property of a document
(In diesem Fall den Titel des Dokuments.)(in this case, the document title)
lists/getbytitle('listname')?select=Title GETGET Not applicable
Erstellt eine ListeCreates a list lists POSTPOST Siehe BeispielSee sample
Fügt einer Liste einen Eintrag hinzu.Adds an item to a list lists/getbytitle('listname')/items POSTPOST Siehe BeispielSee sample


Erstellt eine Liste BeispieldatenCreates a list sample data

{
  '__metadata':{'type':SP.List},
  'AllowContentTypes': true,
  'BaseTemplate': 104 ,
  'ContentTypesEnabled': true,
  'Description': 'My list description ',
  'Title': 'RestTest '
}


Fügt ein Element zu einer Liste hinzu BeispieldatenAdds an item to a list sample data

{
  '__metadata':{'type': SP.Data.'listname'.ListItem},
  'Title': 'MyItem'
}


Unterstützung für BatchaufträgeBatch job support

Der SharePoint Online-REST-Dienst (und der Dienst von SharePoint 2016 (lokal) oder höher) unterstützt die Kombination mehrerer Anforderungen in einem einzelnen Dienstaufruf mithilfe der OData-Abfrageoption $batch.The SharePoint Online (and on-premises SharePoint 2016 or later) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option. Einzelheiten und Links zu Codebeispielen finden Sie unter Erstellen von Batchanforderungen mit den REST-APIs.For details and links to code samples, see Make batch requests with the REST APIs.

OData-RessourcenOData resources

Themen zum SharePoint-REST-DienstSharePoint REST service topics

Verwenden Sie die folgenden Ressourcen, um weitere Informationen zum Verwenden des SharePoint REST-Diensts zu erhalten.To learn more about using the SharePoint REST service, use the following resources.

TitelTitle BeschreibungDescription
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint REST-EndpunktenComplete basic operations using SharePoint REST endpoints Durchführen grundlegender Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, mit der SharePoint-REST-Schnittstelle.Perform basic create, read, update, and delete (CRUD) operations with the SharePoint REST interface.
Arbeiten mit Listen und Listenelementen unter Verwendung von RESTWorking with lists and list items with REST Durchführen grundlegender Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, für Listen und Listenelemente mit der SharePoint REST-Schnittstelle.Perform basic CRUD operations on lists and list items with the SharePoint REST interface.
Arbeiten mit Ordnern und Dateien unter Verwendung von RESTWorking with folders and files with REST Durchführen grundlegender Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, für Ordner und Dateien mit der SharePoint REST-Schnittstelle.Perform basic CRUD operations on folders and files with the SharePoint REST interface.
Navigieren in der im REST-Dienst dargestellten SharePoint-DatenstrukturNavigate the SharePoint data structure represented in the REST service Starten von einem REST-Endpunkt für einen gegebenen SharePoint-Element und Navigieren zu und Zugreifen auf dazugehörige Elemente, z. B. übergeordnete Standorte oder die Bibliotheksstruktur, in der sich das jeweilige Element befindet.Start from a REST endpoint for a given SharePoint item, and navigate to and access related items, such as parent sites or the library structure where that item resides.
Ermitteln von URIs von SharePoint REST-DienstendpunktenDetermine SharePoint REST service endpoint URIs Allgemeine Richtlinien zur Ermittlung von URIs von SharePoint-REST-Endpunkten mithilfe der Signatur der entsprechenden Clientobjektmodell-APIs.General guidelines for determining SharePoint REST endpoint URIs from the signature of the corresponding client object model APIs.
Verwenden von OData-Abfragevorgängen in SharePoint REST-AnforderungenUse OData query operations in SharePoint REST requests Hier erfahren Sie, wie Sie eine Reihe von OData-Abfragezeichenfolgeoperatoren verwenden, um die vom SharePoint REST-Dienst angeforderten Daten auszuwählen, zu filtern und zu ordnen.Use a wide range of OData query string operators to select, filter, and order the data you request from the SharePoint REST service.
Durchführen von Batchanforderungen mit den REST-APIsMake batch requests with the REST APIs Erfahren Sie, wie Sie mehrere Anforderungen zu einem einzigen Aufruf an den REST-Dienst kombinieren.Combine multiple requests into a single call to the REST service.
Synchronisieren von SharePoint-Elementen mit dem REST-DienstSynchronize SharePoint items using the REST service Erfahren Sie, wie Sie mit der Ressource GetListItemChangesSinceToken, die Teil des SharePoint REST-Diensts ist, Elemente zwischen SharePoint und Ihren Add-ins oder Diensten synchronisieren.Synchronize items between SharePoint and your add-ins or services by using the GetListItemChangesSinceToken resource, part of the SharePoint REST service.
Hochladen von Dateien mithilfe der REST-API und jQueryUpload a file by using the REST API and jQuery In den Codebeispielen in diesem Artikel werden die REST-Schnittstelle und jQuery AJAX-Anforderungen verwendet, um eine lokale Datei zur Bibliothek „Documents“ hinzuzufügen und dann die Eigenschaften des Listenelements zu ändern, das die hochgeladene Datei darstellt.The code examples in this article use the REST interface and jQuery AJAX requests to add a local file to the Documents library, and then change properties of the list item that represents the uploaded file.
Festlegen von benutzerdefinierten Berechtigungen in einer Liste mit der REST-SchnittstelleSet custom permissions on a list by using the REST interface SharePoint-Websites, Listen und Listenelemente sind Typen von SecurableObject, das die Berechtigungen seines übergeordneten Elements erbt.SharePoint sites, lists, and list items are types of SecurableObject, which inherits the permissions of its parent. Wenn Sie benutzerdefinierte Berechtigungen für ein Objekt festlegen möchten, müssen Sie die Vererbung der Berechtigungen unterbrechen und dann durch Hinzufügen oder Entfernen von Rollenzuweisungen neue Berechtigungen definieren.To set custom permissions for an object, you need to break its inheritance so that it stops inheriting permissions from its parent, and then define new permissions by adding or removing role assignments.
Grundlegendes zu SharePoint-WorkflowsSharePoint workflow fundamentals 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.Add search functionality to client and mobile applications using the Search REST service in SharePoint Server 2013 and any technology that supports REST web requests.
REST-API-Referenz für sozialen Feed für SharePointSocial feed REST API reference for SharePoint SharePoint-REST-Endpunkte für feedbezogene Aufgaben.SharePoint REST endpoints for feed-related tasks.
REST-API-Referenz zum Folgen von Personen und Inhalten für SharePointFollowing people and content REST API reference for SharePoint SharePoint-REST-Endpunkte zum Folgen von Personen und Inhalten.SharePoint REST endpoints for following people and content.
Entwickeln von SharePoint-Add-InsDevelop SharePoint Add-ins Hier finden Sie ausführliche Artikel und Ressourcen, die Sie dabei unterstützen, erweiterte Funktionen in Ihre SharePoint-Add-Ins zu integrieren.Find in-depth articles and resources to help you build advanced capabilities into your SharePoint Add-ins.
REST-API-Referenz und BeispieleREST API reference and samples Umfassende API-Referenz für das Arbeiten mit Microsoft-Tools, -Diensten und -Technologien.Comprehensive API reference for working with Microsoft tools, services, and technologies. Ganz gleich, ob Sie Apps erstellen, Websites entwickeln oder mit der Cloud arbeiten, hier finden Sie ausführliche Syntax, Codeausschnitte und bewährte Methoden.Whether you're building apps, developing websites, or working with the cloud, you'll find detailed syntax, code snippets, and best practices.