Utilisation des ressources de site SharePoint

Article
04/08/2023

L’API SharePoint dans Microsoft Graph prend en charge les scénarios de base suivants :

Accès aux ressources site, list et drive SharePoint (bibliothèques de documents)
Prise en charge en lecture seule des ressources site (aucune possibilité de créer des sites)
Prise en charge en lecture-écriture des ressources list, listItem et driveItem
Accès aux ressources par ID SharePoint, URL ou chemin d’accès relatif

L’API SharePoint présente trois types de ressources principaux :

Site(cet objet)
List
ListItem

Tâches

Tous les exemples ci-dessous sont relatifs à https://graph.microsoft.com/v1.0.

Nom de la tâche	Exemple de requête
Accéder au site racine	GET /sites/root
Accéder à un site	GET /sites/{site-id}
Accéder à un site via un chemin d’accès	GET /sites/{hostname}:/{site-path}
Obtenir un site pour un groupe	GET /groups/{id-de-groupe}/sites/root
Rechercher des sites	GET /sites?search={query}
Accéder à la bibliothèque de documents par défaut d’un site	GET /sites/{site-id}/drive
Énumérer la collection de bibliothèques de documents sous un site	GET /sites/{site-id}/drives
Énumérer les listes sous un site	GET /sites/{site-id}/lists
Répertorier les sites racine	GET /sites?filter=root ne null&select=siteCollection,webUrl
Rechercher des sites	GET /sites?search={query}

Les sites peuvent également être traités par le chemin d’accès à l’aide du nom d’hôte SharePoint, suivi d’un signe deux-points et du chemin d’accès relatif au site. Vous pouvez éventuellement revenir à l’adressage du modèle de ressource en plaçant un autre signe deux-points à la fin.

Path	Description
/sites/contoso.sharepoint.com:/teams/hr	Site associé à https://contoso.sharepoint.com/teams/hr
/sites/contoso.sharepoint.com:/teams/hr:/drive	Accédez au lecteur par défaut pour ce site.

Représentation JSON

Voici une représentation JSON de la ressource de site.

La ressource site est dérivée de l’élément baseItem et hérite des propriétés de cette 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"
}

Propriétés

Nom de la propriété	Type	Description
id	string	Identificateur unique de l’élément. En lecture seule.
createdDateTime	DateTimeOffset	Date et heure de création de l’élément. En lecture seule.
description	string	Texte descriptif pour le site.
eTag	string	ETag pour l’élément. En lecture seule.
displayName	string	Titre complet du site. En lecture seule.
lastModifiedDateTime	DateTimeOffset	Date et heure de dernière modification de l’élément. En lecture seule.
name	string	Nom/titre de l’élément.
racine	racine	Le cas échéant, indique qu’il s’agit du site racine de la collection de sites. En lecture seule.
sharepointIds	sharepointIds	Renvoie les identificateurs utiles pour garantir la compatibilité de SharePoint REST. En lecture seule.
siteCollection	siteCollection	Fournit des détails sur la collection du site. Disponible uniquement sur le site racine. En lecture seule.
webUrl	chaîne (URL)	URL qui affiche l’élément dans le navigateur. En lecture seule.

Relations

Nom de la relation	Type	Description
columns	Collection(columnDefinition)	Collection des définitions de colonne réutilisables dans plusieurs listes sous ce site.
contentTypes	Collection(contentType)	Collection de types de contenu définis pour ce site.
drive	lecteur	Lecteur par défaut (bibliothèque de documents) pour ce site.
lecteurs	Collection(drive)	Ensemble de lecteurs (bibliothèques de documents) de ce site.
items	Collection(baseItem)	Utilisé pour traiter tout élément figurant dans ce site. Impossible d’énumérer cette collection.
lists	Collection(list)	Collection de listes sous ce site.
sites	Collection(site)	Collection de sous-sites de ce site.

Remarque pour les développeurs de SharePoint

L’API SharePoint pour Microsoft Graph comporte quelques différences clés avec les API CSOM. La ressource site correspond à SPWeb. La ressource site racine (SPWeb) dans une collection de sites a une facette siteCollection, qui contient des informations sur la ressource SPSite. Les ID de sites étant uniques au sein de leur collection de sites, définir un site en fonction de l’ID nécessite de fournir l’identificateur de collection de sites et l’identificateur de site.

GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id},{spweb-id}/

Une URL construite uniquement avec le nom d’hôte pointera vers le site racine (SPWeb) dans la collection de sites par défaut.

GET https://graph.microsoft.com/v1.0/sites/{hostname}

Une URL construite avec uniquement le nom d’hôte et l’ID siteCollection (SPSite) pointera vers le site racine (SPWeb) dans la collection de sites donnée.

GET https://graph.microsoft.com/v1.0/sites/{hostname},{spsite-id}

Share via