Trabajar con recursos de sitio de SharePoint

Artículo
04/08/2023

La API de SharePoint en Microsoft Graph admite los siguientes escenarios principales:

Acceso a los sitios, las listas y las unidades (bibliotecas de documentos) de SharePoint
Soporte de solo lectura de los recursos del sitio (sin capacidad para crear nuevos sitios)
Compatibilidad de lectura y escritura para recursos list, listItem y driveItem
Recursos de dirección por la ruta de acceso relativa, URL o id. de SharePoint

La API de SharePoint expone tres tipos principales de recursos:

Site(este objeto)
Lista
ListItem

Tareas

Todos los ejemplos siguientes son relativos a https://graph.microsoft.com/v1.0.

Nombre de tarea	Solicitud de ejemplo
Obtener sitio raíz	GET /sites/root
Obtener sitio	GET /sites/{site-id}
Obtener sitio por su ruta de acceso	GET /sites/{hostname}:/{site-path}
Obtener sitio para un grupo	GET /groups/{group-id}/sites/root
Buscar sitios	GET /sites?search={query}
Obtener acceso a la biblioteca de documentos predeterminada de un sitio	GET /sites/{site-id}/drive
Enumerar la colección de bibliotecas de documentos del sitio	GET /sites/{site-id}/drives
Enumerar las listas en un sitio	GET /sites/{site-id}/lists
Enumerar sitios raíz	GET /sites?filter=root ne null&select=siteCollection,webUrl
Buscar sitios	GET /sites?search={query}

Los sitios también se pueden abordar por ruta de acceso mediante el nombre de host de SharePoint, seguido de dos puntos y la ruta de acceso relativa al sitio. Opcionalmente, puede volver a abordar el modelo de recursos si coloca otro dos puntos al final.

Ruta de acceso	Descripción
/sites/contoso.sharepoint.com:/teams/hr	El sitio asociado con https://contoso.sharepoint.com/teams/hr
/sites/contoso.sharepoint.com:/teams/hr:/drive	Acceso a la unidad predeterminada de este sitio.

Representación JSON

A continuación se incluye una representación JSON del recurso site.

El recurso site deriva de baseItem y hereda sus propiedades.

{
  "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"
}

Propiedades

Nombre de la propiedad	Tipo	Descripción
id	cadena	El identificador único del elemento. Solo lectura.
createdDateTime	DateTimeOffset	La fecha y la hora de creación del elemento. Solo lectura.
description	string	Texto descriptivo del sitio.
eTag	string	ETag para el elemento. Solo lectura.
displayName	cadena	El título completo del sitio. Solo lectura.
lastModifiedDateTime	DateTimeOffset	Fecha y hora de la última modificación del elemento. Solo lectura.
name	string	Nombre o título del elemento.
root	root	Si está presente, indica que se trata del sitio raíz de la colección de sitios. Solo lectura.
sharepointIds	sharepointIds	Devuelve los identificadores útiles para la compatibilidad con REST de SharePoint. Solo lectura.
siteCollection	siteCollection	Proporciona detalles sobre la colección de sitios del sitio. Solo disponible en el sitio raíz. Solo lectura.
webUrl	string (url)	Dirección URL que muestra el elemento en el explorador. Solo lectura.

Relaciones

Nombre de la relación	Tipo	Descripción
columns	Collection(columnDefinition)	La colección de definiciones de columna reutilizables en listas en este sitio.
contentTypes	Collection(contentType)	La colección de tipos de contenido definidos para este sitio.
drive	drive	La unidad predeterminada (biblioteca de documentos) para este sitio.
drives	Collection(drive)	La colección de unidades (bibliotecas de documentos) de este sitio.
items	Collection(baseItem)	Se utiliza para resolver cualquier elemento contenido en este sitio. Esta colección no se puede enumerar.
lists	Collection(list)	La colección de listas en este sitio.
sites	Collection(site)	La colección de subsitios de este sitio.

Nota para los desarrolladores de SharePoint existentes

La API de SharePoint de Microsoft Graph tiene algunas diferencias clave con las API de CSOM. El recurso del site se asigna a SPWeb. El recurso site raíz (SPWeb) en una colección de sitios tiene una faceta siteCollection, que contiene información sobre SPSite. Debido a que los identificadores para los sitios solo son únicos dentro de su colección de sitios, el direccionamiento a un sitio a través del id. requiere proporcionar el identificador de la colección de sitios y el identificador del sitio.

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

Una dirección URL creada solo con el nombre de host apuntará al sitio raíz (SPWeb) en la colección de sitios predeterminada.

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

Una dirección URL creada solo con el nombre de host y el id. de siteCollection (SPSite) apuntará al sitio raíz (SPWeb) en la colección de sitios predeterminada.

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

Share via