Arbeiten mit SharePoint-Websiteressourcen
Die SharePoint-API in Microsoft Graph unterstützt die folgenden wesentlichen Szenarios:
- Zugriff auf SharePoint-Websites, -Listen und -Laufwerke (Dokumentbibliotheken)
- Schreibgeschützte Unterstützung für Website-Ressourcen (keine Möglichkeit zum Erstellen neuer Websites)
- Lese-/ Schreibzugriff-Unterstützung für -Listen, listItems und driveItems
- Adressierung von Ressourcen nach SharePoint-ID, URL oder relativem Pfad
Die SharePoint-API macht drei wichtige Ressourcentypen verfügbar:
Aufgaben
Alle Beispiele unten beziehen sich auf https://graph.microsoft.com/v1.0
.
Aufgabenname | Beispielanforderung |
---|---|
Stammwebsite abrufen | GET /sites/root |
Website abrufen | GET /sites/{site-id} |
Website nach Pfad abrufen | GET /sites/{hostname}:/{site-path} |
Website für eine Gruppe abrufen | GET /groups/{group-id}/sites/root |
Nach Websites suchen | GET /sites?search={query} |
Zugriff auf die Standard-Dokumentbibliothek für eine Website | GET /sites/{site-id}/drive |
Die Sammlung von Dokumentbibliotheken unter dieser Website. | GET /sites/{site-id}/drives |
Die Listen unterhalb einer Website auflisten | GET /sites/{site-id}/lists |
Stammwebsites auflisten | GET /sites?filter=root ne null&select=siteCollection,webUrl |
Nach Websites suchen | GET /sites?search={query} |
Websites können auch mithilfe des SharePoint-Hostnamens, gefolgt von einem Doppelpunkt und dem relativen Pfad zur Website adressiert werden. Sie können optional wieder zur Adressierung des Ressourcenmodells wechseln, indem Sie einen weiteren Doppelpunkt am Ende setzen.
Path | Beschreibung |
---|---|
/sites/contoso.sharepoint.com:/teams/hr | Die Seite ist https://contoso.sharepoint.com/teams/hr zugeordnet. |
/sites/contoso.sharepoint.com:/teams/hr:/drive | Zugriff auf das standardmäßige Laufwerk für diese Website |
JSON-Darstellung
Es folgt eine JSON-Darstellung einer site-Ressource.
Die site-Ressource wird von baseItem abgeleitet und erbt Eigenschaften von dieser Ressource.
{
"id": "string",
"root": { "@odata.type": "microsoft.graph.root" },
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"siteCollection": {"@odata.type": "microsoft.graph.siteCollection"},
"displayName": "string",
/* relationships */
"contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
"drive": { "@odata.type": "microsoft.graph.drive" },
"drives": [ { "@odata.type": "microsoft.graph.drive" }],
"items": [ { "@odata.type": "microsoft.graph.baseItem" }],
"lists": [ { "@odata.type": "microsoft.graph.list" }],
"sites": [ { "@odata.type": "microsoft.graph.site"} ],
"columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
/* inherited from baseItem */
"name": "string",
"createdDateTime": "datetime",
"description": "string",
"eTag": "string",
"lastModifiedDateTime": "datetime",
"webUrl": "url"
}
Eigenschaften
Eigenschaftenname | Typ | Beschreibung |
---|---|---|
id | string | Der eindeutige Bezeichner des Elements. Schreibgeschützt. |
createdDateTime | DateTimeOffset | Das Datum und die Uhrzeit der Erstellung des Elements. Schreibgeschützt. |
description | string | Der beschreibende Text für die Website. |
eTag | string | ETag für das Element. Schreibgeschützt. |
displayName | string | Der vollständigen Titel für die Website. Schreibgeschützt. |
lastModifiedDateTime | DateTimeOffset | Das Datum und die Uhrzeit der letzten Änderung des Elements. Schreibgeschützt. |
name | string | Der Name/Titel des Elements. |
root | root | Falls vorhanden, gibt diese Eigenschaft an, dass es sich um die Stammwebsite in der Websitesammlung handelt. Schreibgeschützt. |
sharepointIds | sharepointIds | Gibt Bezeichner zurück, die für SharePoint REST-Kompatibilität nützlich sind. Schreibgeschützt. |
siteCollection | siteCollection | Stellt Details über die Websitesammlung der Website bereit. Nur für die Stammwebsite verfügbar. Schreibgeschützt. |
webUrl | String (URL) | URL, über die das Element im Browser angezeigt werden kann. Schreibgeschützt. |
Beziehungen
Beziehungsname | Typ | Beschreibung |
---|---|---|
columns | Sammlung (ColumnDefinition) | Die Sammlung der wiederverwendbaren Spaltendefinitionen von Listen unterhalb dieser Website. |
contentTypes | Sammlung (contentType) | Die Sammlung von für diese Website definierten Inhaltstypen. |
drive | drive | Das Standardlaufwerk (Dokumentbibliothek) für diese Website. |
drives | Sammlung (drive) | Die Sammlung von Laufwerken (Dokumentbibliotheken) unter dieser Website. |
items | Sammlung (baseItem) | Wird verwendet, um ein beliebiges in dieser Website enthaltenes Element zu adressieren. Diese Sammlung kann nicht aufgezählt werden. |
Listen | Sammlung (Liste) | Die Sammlung der Listen unter dieser Website. |
sites | Sammlung (site) | Die Sammlung der Unterwebsites unter dieser Website. |
Hinweis für bestehende SharePoint-Entwickler
Zwischen der Microsoft Graph-SharePoint-API und den CSOM-APIs bestehen einige wesentliche Unterschiede.
Die site-Ressource ist SPWeb
zugeordnet.
Die Stammwebsite (SPSite
) in einer Websitesammlung verfügt über ein siteCollection-Facet, das Informationen über enthält.
Da IDs für Websites nur innerhalb einer Websitesammlung eindeutig sind, müssen zur Adressierung einer Website nach ID sowohl die Websitesammlungs-ID als auch die Website-ID angegeben werden.
GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id},{spweb-id}/
Eine URL, die nur mit dem Hostnamen gebildet wird, verweist auf die Stammwebsite (SPWeb
) in der Standard-Websitesammlung.
GET https://graph.microsoft.com/v1.0/sites/{hostname}
Eine URL, die nur mit dem Hostnamen und der Websitesammlungs-ID (SPSite
) gebildet wird, verweist auf die Stammwebsite (SPWeb
) in der angegebenen Websitesammlung.
GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id}