SharePoint mit Geschäftssystemen verbinden – Grundlegendes zur REST API-Schnittstelle
SharePoint bildet als Intranet in vielen Organisationen den Dreh- und Angelpunkt für die zentralen Geschäftssysteme. Damit externe Anwendungen mit SharePoint-Websites und Datenbanken verbunden werden können, stellt Microsoft als Schnittstelle die SharePoint REST API zur Verfügung. Mittels dieser standardisierten Methode können Unternehmen sehr einfach Anbindungen an SharePoint einrichten.
Die SharePoint REST API stellt eine effiziente Möglichkeit dar, um auf SharePoint-Daten von Extern zuzugreifen und mit ihnen zu interagieren. Sie bietet so eine Alternative zu klassischen Client-APIs. Dieser Beitrag erklärt die Grundlagen der SharePoint REST API.
REST – ein Client-Server-Kommunikationsmodell
REST – das Kürzel steht für „Representational State Transfer“ – ist eine architektonische Methode für das Design und die Entwicklung von vernetzten Systemen. Es handelt sich dabei um ein leichtgewichtiges und flexibles Verfahren zur Remote-Interaktion mit SharePoint unter Verwendung aller Technologien, die das REST-Protokoll unterstützt.
REST legt den Schwerpunkt auf ein zustandsloses Client-Server-Kommunikationsmodell, bei dem Clients Anfragen an Server senden, um Aktionen mit Ressourcen durchzuführen. Diese Anfragen erfolgen in der Regel in Form von HTTP-Methoden wie GET, POST, PUT, PATCH und DELETE, die auf verschiedene Operationen an den Ressourcen ausgerichtet sind.
Die REST-Architektur konzentriert sich auf den Begriff der Ressourcen, die durch eindeutige URLs identifiziert werden. Sie basiert auf dem Standard Open Data Protocol (OData) und ermöglicht es Entwicklern, grundlegende Operationen zum Erstellen, Lesen, Aktualisieren und Löschen (CRUD) über eine RESTful-HTTP-Anfrage durchzuführen.
Im Kontext von SharePoint können Ressourcen Elemente in einer SharePoint-Liste sein, Dokumente in einer SharePoint-Bibliothek oder sogar die SharePoint-Website selbst sein. Durch die Interaktion mit diesen Ressourcen über HTTP-Anfragen können Clients Informationen abrufen, Änderungen vornehmen und andere Aktionen durchführen.
Schlüsselkonzepte der Sharepoint REST API
1. Endpunkte: SharePoint-Ressourcen wie Listen, Bibliotheken oder Websites werden über bestimmte URLs, sogenannte Endpunkte, zugänglich gemacht. Diese Endpunkte sind die Einstiegspunkte für die Interaktion mit SharePoint-Ressourcen über die REST-API.
2. HTTP-Anforderungen und -Methoden: Um mit der SharePoint REST API zu arbeiten, müssen Sie HTTP-Anforderungen erstellen und an die entsprechenden SharePoint API-Endpunkte senden. Diese HTTP-Anforderungen verwenden verschiedene Methoden, um grundlegende Vorgänge auszuführen:
– GET: Abrufen von Informationen vom Server
– POST: Erstellen eines neuen Elements auf dem Server
– PUT: Aktualisieren eines vorhandenen Elements auf dem Server
– PATCH: Aktualisierung eines bestehenden Eintrags.
– DELETE: Entfernen eines Objekts vom Server
Eine HTTP-GET-Anforderung an diesen Endpunkt ruft beispielsweise eine Liste von Elementen von einer Sharepoint-Website ab: https://example.sharepoint.com/_api/web/lists/getbytitle(‚Listenname‘)/items
3. Erstellen von Anfragen und Bearbeiten von Antworten: Um mit der SharePoint REST-API zu interagieren, müssen Entwickler HTTP-Anforderungen mit den erforderlichen Informationen erstellen. Das können zum Beispiel Zielendpunkte sein, Kopfzeilen und manchmal auch Anforderungsdaten. Die Anforderungen werden an den SharePoint-Server gesendet, der sie verarbeitet und Antworten zurückgibt. Diese Antworten enthalten die verlangten Daten, die Bestätigung eines erfolgreichen Vorgangs oder Fehlermeldungen, falls Probleme auftreten.
4. Sharepoint-Client-Objektmodelle: Die SharePoint REST API bietet Funktionen, die verschiedenen Client-Objektmodellen entsprechen, darunter:
– JavaScript (JSOM): Über JavaScript-Bibliotheken können Sie mit Sharepoint aus der Ferne interagieren.
– Silverlight (CSOM): Mithilfe von .NET-Bibliotheken können Sie Silverlight-Anwendungen erstellen, die mit Sharepoint funktionieren.
– Verwaltetes .NET (CSOM): Mithilfe von C# oder Visual Basec können Sie Client-Anwendungen erstellen, die mit Sharepoint kompatibel sind, indem Sie verwalteten .NET-Code verwenden.
– Mobil (MCSOM): Sie können Windows Phone-Anwendungen erstellen, die SharePoint REST API mit Microsofts Mobile Client Object Model nutzen, um mit allen SharePoint-Entitäten wie Listen, SharePoint-Bibliotheken, Inhaltstypen und mehr zu interagieren.
5. SharePoint Online: Im Zusammenhang mit SharePoint Online spielt die REST-API eine entscheidende Rolle, da sie die Integration von SharePoint-Inhalten und -Funktionen in verschiedene Client- und mobile Anwendungen ermöglicht.
Die SharePoint Search REST API ermöglicht es Ihnen, Suchfunktionen zu Ihren Anwendungen hinzuzufügen, um SharePoint-Benutzern einen nahtlosen und effizienten Zugang zu SharePoint-Inhalten von verschiedenen Plattformen und Geräten aus zu ermöglichen.
Das Verständnis dieser grundlegenden Konzepte bildet eine solide Grundlage für die Arbeit mit der SharePoint REST API.
Die praktischen Aspekte der Integration mit SharePoint unter Verwendung der REST-API werden in einem gesonderten Beitrag vorgestellt.
- Übersicht: 5 SharePoint-Tools für Dokumenten- und Site-Migrationen - 27. November 2023
- SharePoint Lookbook: So nutzen Sie die kostenlosen Vorlagen für funktionale Website-Designs (Teil 1) - 23. November 2023
- OneNote, OneDrive oder SharePoint – welcher Dokumentenspeicher eignet sich für was? - 21. November 2023