SharePoint REST-Service
SharePoint umfasst einen REST-Dienst (Representational State Transfer), der mit den bestehenden SharePoint Client-Objektmodellen vergleichbar ist. Jetzt können Entwickler remote mit SharePoint-Daten mithilfe einer beliebigen Technologie interagieren, die REST-Webanforderungen unterstützt. Im Wesentlichen können Entwickler Vorgänge zum Lesen, Aktualisieren und Löschen (CRUD) über ihre SharePoint-Add-Ins, Lösungen und Clientanwendungen ausführen, indem sie REST-Webtechnologien und die Open Data Protocol-Standardsyntax (OData) verwenden.
So funktioniert der SharePoint REST-Dienst
SharePoint fügt die Möglichkeit hinzu, dass Sie remote mi SharePoint-Standorten mithilfe von REST interagieren können. Sie können nun direkt mit SharePoint-Objekten durch Verwendung einer beliebigen Technologie interagieren, die REST-Standardfunktionen unterstützt.
Um auf SharePoint-Ressourcen durch Verwendung von REST zuzugreifen, können Sie eine RESTful HTTP-Anforderung konstruieren, indem Sie den OData-Standard verwenden, der der gewünschten Clientobjektmodell-API entspricht, wie im folgenden Beispiel angezeigt:
GET https://{site_url}/_api/lists/getbytitle('{list_name}')/items
Authorization: "Bearer " + accessToken
Accept: "application/json;odata=verbose"
Die HTTP-Befehle mit dem SharePoint REST-Dienst verwenden
Um die REST-Funktionen zu verwenden, die in SharePoint integriert sind, können Sie eine RESTful-HTTP-Anforderung konstruieren, indem Sie den OData-Standard verwenden, der der Clientobjektmodell-API entspricht, die Sie verwenden möchten. Der client.svc-Webdienst verarbeitet die HTTP-Anforderung und stellt die entsprechende Antwort entweder im Atom- oder im JSON-Format bereit. Dann muss die Clientanwendung diese Antwort analysieren.
Die Endpunkte im SharePoint REST-Dienst entsprechen den Typen und Mitgliedern in den SharePoint Client-Objektmodellen. Mithilfe von HTTP-Anforderungen können Sie diese REST-Endpunkte verwenden, um typische CRUD-Operationen für SharePoint-Entitäten wie Listen und Websites auszuführen.
Die folgende Tabelle stellt einen Überblick über die HTTP-Anforderungen bereit.
| Aktion | HTTP-Anforderung | Beachten |
|---|---|---|
| Eine Ressource lesen | GET | Das zurückgegebene Datenformat muss möglicherweise geändert werden. |
| Eine Ressource erstellen oder aktualisieren | POST | Verwenden Sie POST, um Entitäten wie Listen und Websites zu erstellen. Der SharePoint REST-Dienst unterstützt das Senden von POST-Befehlen, die Objektdefinitionen für Endpunkte enthalten, die Sammlungen darstellen. Für POST-Vorgänge werden nicht erforderliche Eigenschaften auf ihre Standardwerte gesetzt. Wenn Sie versuchen, eine schreibgeschützte Eigenschaft als Teil eines POST-Vorgangs festzulegen, gibt der Dienst eine Ausnahme zurück. |
| Eine Ressource aktualisieren oder einfügen | PUT | Verwenden Sie PUT- und MERGE-Vorgänge, um vorhandene SharePoint-Objekte zu aktualisieren. Jeder Service-Endpunkt, der einen Vorgang zum Festlegen von Objekteigenschaften darstellt, unterstützt PUT-Anforderungen und MERGE-Anforderungen. Für MERGE-Anforderungen ist das Festlegen von Eigenschaften optional. Eigenschaften, die Sie nicht explizit festlegen, behalten ihre aktuelle Eigenschaft bei. Wenn Sie bei PUT-Anforderungen nicht alle erforderlichen Eigenschaften in Objektaktualisierungen angeben, gibt der REST-Service eine Ausnahme zurück. Optionale Eigenschaften, die Sie nicht explizit angeben, werden auf ihre Standardeigenschaften festgelegt. |
| Eine Ressource löschen | DELETE | Verwenden Sie den Befehl HTTP DELETE für die spezifische Endpunkt-URL, um das SharePoint-Objekt zu löschen, das von diesem Endpunkt dargestellt wird. Wiederverwendbare Objekte wie Listen, Dateien und Listenelemente sind verfügbar, was zu einem Recycle-Vorgang führt. |
REST-URLs für den Zugriff auf SharePoint-Ressourcen erstellen
SharePoint verwendet REST-APIs. Eine API ist ein Software-Vermittler, mit dem zwei Anwendungen miteinander kommunizieren können. Jedes Mal, wenn Sie eine App auf Ihrem Telefon verwenden, um das Wetter zu überprüfen, verwenden Sie eine API.
Um SharePoint REST-Dienstendpunkte zu erstellen, gehen Sie wie folgt vor:
Beginnen Sie mit der REST-Dienstreferenz:
https://{site_url}/_apiGeben Sie den entsprechenden Einstiegspunkt an, zum Beispiel:
https://{site_url}/_api/webBeispiel:
https://contoso.sharepoint.com/_api/webWechseln Sie vom Einstiegspunkt zu den spezifischen Ressourcen, auf die Sie zugreifen möchten, einschließlich der Angabe von Parametern für Endpunkte, die Methoden im Clientobjektmodell entsprechen, z. B.:
https://{site_url}/_api/web/lists/getbytitle('list_name')Beispiel:
https://contoso.sharepoint.com/_api/Lists/getbytitle('TestList')