(0) exportieren Drucken
Alle erweitern
Dieser Artikel wurde noch nicht bewertet - Dieses Thema bewerten.

Erste Schritte mit dem SharePoint 2013 REST-Dienst

apps for SharePoint

Grundlagen der Verwendung des SharePoint 2013-REST-Diensts zum Zugreifen auf und Aktualisieren von SharePoint-Daten mithilfe der REST- und OData-Webprotokollstandards.

Letzte Änderung: Montag, 15. Juli 2013

Gilt für: SharePoint Foundation 2013 | SharePoint Server 2013

SharePoint 2013 führt einen REST-Dienst (Representational State Transfer) ein, der mit bestehenden SharePoint-Clientobjektmodellen vergleichbar ist. Entwickler können jetzt mithilfe jeder Technologie, die REST-Webanforderungen unterstützt, remote mit SharePoint-Daten interagieren. Das bedeutet, dass Entwickler mithilfe von REST-Webtechnologien und standardmäßiger OData-Syntax Create-, Read-, Update- und Delete (CRUD)-Vorgänge in ihren Apps für SharePoint, Lösungen und Clientanwendungen durchführen können.

SharePoint 2013 bietet Ihnen jetzt die Möglichkeit, mithilfe von REST remote mit SharePoint-Websites zu interagieren. Sie können jetzt mithilfe jeder Technologie, die standardmäßige REST-Funktionen unterstützt, direkt mit SharePoint-Objekten interagieren.

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:

Clientobjektmodell-Methode:

List.GetByTitle(listname)

REST-Endpunkt:

http://server/site/_api/lists/getbytitle('listname')

Der client.svc-Webdienst in SharePoint verarbeitet die HTTP-Anforderung und liefert die entsprechende Antwort im Atom- oder JSON-Format (JavaScript Object Notation). Ihre Clientanwendung muss diese Antwort dann analysieren. Die unten stehende Abbildung zeigt eine allgemeine Übersicht über die REST-Architektur von SharePoint.

Architektur des SharePoint-REST-Diensts

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.

Verwenden von HTTP-Befehlen mit dem SharePoint 2013-REST-Dienst

Um die REST-Funktionen zu nutzen, die in SharePoint 2013 integriert sind, erstellen Sie mithilfe des OData-Standards, welcher der Clientobjektmodell-API entspricht, die Sie verwenden möchten, eine RESTful-HTTP-Anforderung. Der client.svc-Webdienst in SharePoint verarbeitet die HTTP-Anforderung und liefert die entsprechende Antwort im Atom- oder JSON-Format (JavaScript Object Notation). Die Clientanwendung muss diese Antwort dann analysieren.

Die Endpunkte im SharePoint 2013-REST-Dienst entsprechen den Typen und Mitgliedern in den SharePoint-Clientobjektmodellen. Mithilfe von HTTP-Anforderungen können Sie diese REST-Endpunkte verwenden, um typische CRUD-Vorgänge für SharePoint-Entitäten wie Listen und Websites durchzuführen.

Allgemein gilt:

Wenn Sie diese Aktion für einen Endpunkt ausführen möchten

Verwenden Sie diese HTTP-Anforderung

Beachten Sie

Lesen einer Ressource

GET

Erstellen oder Aktualisieren einer Ressource

POST

Verwenden Sie POST, um Entitäten wie Listen und Websites zu erstellen. Der SharePoint 2013-REST-Dienst unterstützt das Senden von POST-Befehlen, die Objektdefinitionen enthalten, an Endpunkte, die Sammlungen darstellen.

Bei POST-Vorgängen werden Eigenschaften, die nicht benötigt werden, auf die Standardwerte zurückgesetzt. Wenn Sie versuchen, eine schreibgeschützte Eigenschaft als Teil eines POST-Vorgangs festzulegen, gibt der Dienst eine Ausnahme zurück.

Aktualisieren oder Einfügen einer Ressource

PUT

Verwenden Sie PUT- und MERGE-Vorgänge, um vorhandene SharePoint-Objekte zu aktualisieren.

Jeder Dienstendpunkt, der einen set-Vorgang einer Objekteigenschaft darstellt, unterstützt sowohl PUT-Anforderungen als auch MERGE-Anforderungen.

  • Bei MERGE-Anforderungen ist das Festlegen von Eigenschaften optional; Eigenschaften, die Sie nicht explizit festlegen, bleiben unverändert.

  • Wenn Sie bei PUT-Anforderungen in Objektupdates nicht alle erforderlichen Eigenschaften festlegen, gibt der REST-Dienst eine Ausnahme zurück. Darüber hinaus werden alle optionalen Eigenschaften, die Sie nicht explizit festlegen, auf ihre Standardeigenschaften festgelegt.

Löschen einer Ressource

DELETE

Verwenden Sie den DELETE-HTTP-Befehl für die entsprechende Endpunkt-URL, um das von diesem Endpunkt dargestellte SharePoint-Objekt zu löschen.

Bei wiederverwendbaren Objekten wie Listen, Dateien und Listenelementen führt dies zu einem Recycle-Vorgang.

Erstellen von REST-URLs, um auf SharePoint-Ressourcen zuzugreifen

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.

Gehen Sie folgendermaßen vor, um auf eine bestimmte Websitesammlung zuzugreifen:

http://server/site/_api/site

Gehen Sie folgendermaßen vor, um auf eine bestimmte Website zuzugreifen:

http://server/site/_api/web

In beiden Fällen stellt server den Namen des Servers dar, und site steht für den Namen der entsprechenden Website oder den Pfad zu dieser Website.

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.

Diese Syntax kann nicht für die SocialFeedManager- oder die SocialFollowingManager-REST-API verwendet werden. Weitere Informationen finden Sie in Für Kommunikation über soziale feed REST-API-Referenz für SharePoint 2013 und In der folgenden Menschen und Inhalte REST-API-Referenz für SharePoint 2013.

Weitere Richtlinien zur Ermittlung von URIs von SharePoint-REST-Endpunkten aus der Signatur der entsprechenden Clientobjektmodell-APIs finden Sie in Ermitteln von URIs von SharePoint-REST-Dienstendpunkten.

Die folgende Tabelle enthält Beispiele für typische REST-Endpunkt-URLs, um Ihnen den Einstieg in die Arbeit mit SharePoint-Daten zu erleichtern. Stellen Sie den in der Tabelle enthaltenen URL-Fragmenten http://server/site/_api/ voran, um eine vollständig qualifizierte REST-URL zu erstellen. Wo dies für POST-Befehle erforderlich ist, enthält die Tabelle Beispieldaten, die Sie im Textkörper der HTTP-Anforderung übergeben müssen, um das angegebene SharePoint-Element zu erstellen. Elemente in Schrägschrift stellen Variablen dar, die Sie durch Ihre Werte ersetzen müssen.

Beschreibung

URL-Endpunkt

HTTP-Methode

Textkörperinhalt

Ruft den Titel einer Liste ab

web/title

GET

Nicht zutreffend

Ruft alle Listen auf einer Website ab

lists

GET

Nicht zutreffend

Ruft die Metadaten einer einzelnen Liste ab

lists/getbytitle('listname')

GET

Nicht zutreffend

Ruft Elemente in einer Liste ab

lists/getbytitle('listname')/items

GET

Nicht zutreffend

Ruft eine bestimmte Eigenschaft eines Dokuments ab. (In diesem Fall den Dokumenttitel.)

lists/getbytitle('listname')?select=Title

GET

Nicht zutreffend

Erstellt eine Liste

lists

POST

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

Fügt einer Liste ein Element hinzu

lists/getbytitle('listname')/items

POST

{
  '_metadata':{'type':SP. listnameListItem},
  'Title': 'MyItem'
}

Verwenden Sie die unten aufgeführten Ressourcen, um mehr über die Verwendung des SharePoint-REST-Diensts zu erfahren.

Gewusst wie: Ausführen grundlegender Vorgänge unter Verwendung von SharePoint 2013-REST-Endpunkten

In diesem Artikel erfahren Sie, wie Sie grundlegende Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, mit der SharePoint 2013-REST-Schnittstelle durchführen.

Arbeiten mit Listen und Listenelementen unter Verwendung von REST

Erfahren Sie, wie Sie grundlegende Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, für Listen und Listenelemente mit der SharePoint 2013-REST-Schnittstelle durchführen.

Arbeiten mit Ordnern und Dateien mit REST

Erfahren Sie, wie Sie grundlegende Erstellungs-, Lese-, Aktualisierungs- und Löschoperationen, auch als CRUD-Operationen (Create, Read, Update, Delete) bezeichnet, für Ordner und Dateien mit der SharePoint 2013-REST-Schnittstelle durchführen.

Navigieren durch die im REST-Dienst dargestellte SharePoint-Datenstruktur

Erfahren Sie, wie Sie ausgehend von einem REST-Endpunkt für ein bestimmtes SharePoint-Element zu verwandten Elementen wie übergeordneten Websites oder der Bibliothekstruktur, in der sich das Element befindet, navigieren.

Ermitteln von URIs von SharePoint-REST-Dienstendpunkten

Hier finden Sie allgemeine Richtlinien zur Ermittlung von SharePoint-REST-Endpunkte-URIs aus der Signatur der entsprechenden Clientobjektmodell-APIs.

Verwenden von OData-Abfragevorgängen in SharePoint REST-Anforderungen

Erfahren Sie, wie Sie die Daten, die Sie vom SharePoint-REST-Dienst anfordern, mithilfe einer breiten Palette von OData-Abfragezeichenfolgen-Operatoren auswählen, filtern und sortieren.

SharePoint 2013 – REST-API, Endpunkte und Beispiele

Diese Seite enthält Links zu allen REST-Ressourcen, die auf MSDN für SharePoint 2013-Entwickler verfügbar sind.

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

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.

Für Kommunikation über soziale feed REST-API-Referenz für SharePoint 2013

Informieren Sie sich über SharePoint 2013-REST-Endpunkte für feedbezogene Aufgaben.

In der folgenden Menschen und Inhalte REST-API-Referenz für SharePoint 2013

Informieren Sie sich über SharePoint 2013-REST-Endpunkte zum Folgen von Personen und Inhalten.

Fanden Sie dies hilfreich?
(1500 verbleibende Zeichen)
Vielen Dank für Ihr Feedback.
Microsoft führt eine Onlineumfrage durch, um Ihre Meinung zur MSDN-Website zu erfahren. Wenn Sie sich zur Teilnahme entscheiden, wird Ihnen die Onlineumfrage angezeigt, sobald Sie die MSDN-Website verlassen.

Möchten Sie an der Umfrage teilnehmen?
Anzeigen:
© 2014 Microsoft. Alle Rechte vorbehalten.