Trabalhar com recursos do site do SharePoint

Artigo
04/08/2023

A API do SharePoint no Microsoft Graph oferece suporte aos seguintes cenários principais:

Acesso aos sites, lists e drives do SharePoint (bibliotecas de documentos)
Suporte somente leitura para recursos de site (nenhuma capacidade de criar novos sites)
Suporte a leitura e gravação para lists, listItems e driveItems
Lidar com recursos por ID do SharePoint, URL ou caminho relativo

A API do SharePoint expõe três tipos de recursos principais:

Site(este objeto)
List
ListItem

Tarefas

Todos os exemplos a seguir referem-se ao endereço https://graph.microsoft.com/v1.0.

Nome da tarefa	Exemplo de Solicitação
Obter site raiz	GET /sites/root
Obter site	GET /sites/{site-id}
Obter site por caminho	GET /sites/{hostname}:/{site-path}
Obter o site para um grupo	GET /groups/{group-id}/sites/root
Procurar sites	GET /sites?search={query}
Acessar a biblioteca de documentos padrão de um site	GET /sites/{site-id}/drive
Enumerar o conjunto de bibliotecas de documentos no site	GET /sites/{site-id}/drives
Enumerar as listas em um site	GET /sites/{site-id}/lists
Lista sites raiz	GET /sites?filter=root ne null&select=siteCollection,webUrl
Procurar sites	GET /sites?search={query}

Os sites também podem ser abordados por caminho através do nome de anfitrião do SharePoint, seguido de dois pontos e do caminho relativo para o site. Opcionalmente, pode fazer a transição de volta para abordar o modelo de recursos ao colocar outro ponto no final.

Caminho	Descrição
/sites/contoso.sharepoint.com:/teams/hr	O site associado comhttps://contoso.sharepoint.com/teams/hr
/sites/contoso.sharepoint.com:/teams/hr:/drive	Acessar o drive padrão desse site.

Representação JSON

Veja a seguir uma representação JSON de um recurso site.

O recurso site é derivado de baseItem e herda propriedades desse recurso.

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

Propriedades

Nome da propriedade	Tipo	Descrição
id	string	O identificador exclusivo do item. Somente leitura.
createdDateTime	DateTimeOffset	A data e a hora da criação do item. Somente leitura.
description	string	O texto descritivo do site.
eTag	string	ETag do item. Somente leitura.
displayName	string	O texto completo do site. Somente leitura.
lastModifiedDateTime	DateTimeOffset	A data e a hora que o item foi modificado pela última vez. Somente leitura.
name	string	O nome/título do item.
root	root	Se estiver presente, indica que este é o site raiz do conjunto de sites. Somente leitura.
sharepointIds	sharepointIds	Retorna os identificadores úteis para fins de compatibilidade do REST do SharePoint. Somente leitura.
siteCollection	siteCollection	Fornece detalhes sobre o conjunto de sites do site. Disponível apenas no site raiz. Somente leitura.
webUrl	string (url)	A URL que exibe o item no navegador. Somente leitura.

Relações

Nome da relação	Tipo	Descrição
columns	Collection(columnDefinition)	O conjunto de definições de coluna reutilizáveis entre listas nesse site.
contentTypes	Collection(contentType)	O conjunto de tipos de conteúdo definido para esse site.
drive	drive	A unidade padrão (biblioteca de documentos) desse site.
drives	Collection(drive)	O conjunto de unidades (bibliotecas de documentos) nesse site.
items	Collection(baseItem)	Usado para lidar com qualquer item contido neste site. Não é possível enumerar este conjunto.
lists	Collection(list)	O conjunto de listas neste site.
sites	Collection(site)	O conjunto dos subsites neste site.

Observação para desenvolvedores do SharePoint existentes

A API do Microsoft Graph do SharePoint tem algumas diferenças essenciais das APIs CSOM. Os recurso do site mapeia para SPWeb. O site (SPWeb) raiz em um conjunto de sites tem uma faceta siteCollection, que contém informações sobre SPSite. Como as IDs de sites são exclusivas penas em sua coleção de site, abordar um site por ID requer o fornecimento do identificador de coleção de site e identificador de site.

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

Uma URL construída com apenas o nome do host apontará para o site raiz (SPWeb) na coleção de sites padrão.

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

Uma URL construída apenas com o nome do host e ID de siteCollection (SPSite) apontará o site raiz (SPWeb) na coleção de sites determinada.

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

Compartilhar via