Nota
O acesso a esta página requer autorização. Pode tentar iniciar sessão ou alterar os diretórios.
O acesso a esta página requer autorização. Pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
O recurso site fornece metadados e relações para um site do SharePoint.
Métodos
| Método | Caminho REST |
|---|---|
| Create | POST /sites |
| Get | GET /sites/{site-id} |
| Obter site raiz | GET /sites/root |
| Obter site por caminho | GET /sites/{hostname}:/{site-path} |
| Obter o site para um grupo | GET /groups/{group-id}/sites/root |
| Obter análises | GET /sites/{site-id}/analytics |
| Obter atividades por intervalo | GET /sites/{site-id}/getActivitiesByInterval |
| Listar páginas | GET /sites/{site-id}/pages |
| Listar modelos de página | GET /sites/{site-id}/pageTemplates/microsoft.graph.pageTemplate |
| Lista sites raiz | GET /sites?filter=root ne null&select=siteCollection,webUrl |
| Listar sites entre regiões geográficas | GET /site/getAllSites |
| Listar subsites para um site | GET /sites/{site-id}/sites |
| Procurar sites | GET /sites?search={query} |
| Site de Arquivo Morto | POST /sites/{site-id}/archive |
| Desarquivar site | POST /sites/{site-id}/unarchive |
| Seguir site | POST /users/{user-id}/followedSites/add |
| Deixar de seguir site | POST /users/{user-id}/followedSites/remove |
| Listar sites seguidos | GET /me/followedSites |
| Obter permissão | GET /sites/{site-id}/permissions/{permission-id} |
| Listar permissões | GET /sites/{site-id}/permissions |
| Criar permissões | POST /sites/{site-id}/permissions |
| Excluir permissão | DELETE /sites/{site-id}/permissions/{permission-id} |
| Atualizar permissão | PATCH /sites/{site-id}/permissions/{permission-id} |
| Tipos de conteúdo de lista | Obter /sites/{site-id}/contentTypes |
| Criar contentType | POSTAR /sites/{site-id}/contentTypes |
| Colunas de lista | OBTER /sites/{site-id}/columns |
| Criar coluna | POSTAR /sites/{site-id}/columns |
| Criar trabalho de processamento de documentos | POST /sites/{site-id}/documentProcessingJobs |
| Listar operações | OBTER /sites/{site-id}/operações |
| Obter o status da operação | GET /sites/getOperationStatus(operationId='{siteOperationId}') |
| Obter configurações do site | GET /sites/{site-id}/settings |
| Obter delta | GET /sites/delta |
| Extensões abertas | |
| Criar extensão aberta | POST /sites/{site-id}/extensions |
| Obter extensão aberta | GET /sites/{site-id}/extensions |
| Atualizar extensão aberta | PATCH /sites/{site-id}/extensions |
| Excluir extensão aberta | DELETE /sites/{site-id}/extensions |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| createdDateTime | DateTimeOffset | A data e hora em que o site foi criado. Somente leitura. Herdado de baseItem. |
| description | Cadeia de caracteres | O texto descritivo do site. Herdado de baseItem. |
| displayName | Cadeia de caracteres | O texto completo do site. Somente leitura. |
| eTag | String | ETag para o site. Somente leitura. Herdado de baseItem. |
| id | Cadeia de caracteres | O identificador exclusivo do site. Somente leitura. Herdado de baseItem. |
| lastModifiedDateTime | DateTimeOffset | A data e hora em que o site foi modificado pela última vez. Somente leitura. Herdado de baseItem. |
| localidade | Cadeia de caracteres | As configurações de idioma do site. |
| lockState | siteLockState | O estado do site. Os valores possíveis são: unlocked, lockedReadOnly, lockedNoAccess, lockedNoAdditions, unknownFutureValue |
| nome | Cadeia de caracteres | O nome do site. Herdado de baseItem. |
| ownerIdentityToResolve | identityInput | O proprietário do site a ser fornecido somente no momento da criação do site. |
| root | root | Se presente, fornece o site raiz no conjunto de sites. Somente leitura. |
| settings | siteSettings | As configurações neste site. Somente leitura. |
| shareByEmailEnabled | Booliano | Determina se o site e seu conteúdo podem ser compartilhados por email. |
| 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. |
| template | siteTemplateType | Especifica o modelo aplicado ao site. Os valores possíveis são: sitepagepublishing, sts, unknownFutureValue. |
| webUrl | String | A URL do site que só pode ser fornecida no momento da criação do site. Somente leitura. Herdado de baseItem. |
propriedade do id
Um site é identificado por um ID exclusivo que é composto pelos seguintes valores:
- Hostname do conjunto de sites (contoso.sharepoint.com)
- ID exclusiva do conjunto de sites (GUID)
- ID exclusiva do site (GUID)
O identificador root sempre faz referência ao site raiz de um determinado destino, como a seguir:
-
/sites/root: O site raiz do locatário. -
/groups/{group-id}/sites/root: O site da equipe do grupo.
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| análise | itemAnalytics | Análise sobre as atividades de visualização que ocorreram neste site. |
| columns | coleção columnDefinition | O conjunto de definições de coluna reutilizáveis entre listas nesse site. |
| contentModels | coleção contentModel | A coleção de modelos de conteúdo aplicados a este site. |
| contentTypes | Coleção contentType | O conjunto de tipos de conteúdo definido para esse site. |
| Unidade | drive | A unidade padrão (biblioteca de documentos) desse site. |
| documentProcessingJobs | Coleção documentProcessingJob | Os trabalhos de processamento de documentos em execução neste site. |
| unidades | Coleção drive | O conjunto de unidades (bibliotecas de documentos) nesse site. |
| extensions | Coleção extension | A coleção de extensões abertas definida para este site. Anulável. |
| externalColumns | coleção columnDefinition | A coleção de definições de coluna disponíveis no site que é referenciada dos sites na hierarquia pai do site atual. |
| items | coleção baseItem | Usado para lidar com qualquer item contido neste site. Esta coleção não pode ser enumerada. |
| listas | coleção de listas | O conjunto de listas neste site. |
| operations | Coleção richLongRunningOperation | A coleção de operações de execução prolongada para o site. |
| páginas | baseSiteConjunto de páginas | A coleção de páginas na lista baseSitePages neste site. |
| pageTemplates | coleção pageTemplate | A coleção de modelos de página neste site. |
| permissões | Coleção permission | As permissões associadas ao site. Anulável. |
| Lixeira | Lixeira | Um contêiner para uma coleção de recursos recycleBinItem neste site. |
| sites | conjunto de sites | O conjunto dos subsites neste site. |
| LojaDeTermos | microsoft.graph.termStore.store | A LojaDeTermos sob este site. |
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
O recurso site é derivado de baseItem e herda propriedades desse recurso.
{
"displayName": "string",
"id": "string",
"locale": "String",
"lockState": "String",
"ownerIdentityToResolve": {"@odata.type": "microsoft.graph.identityInput"},
"root": { "@odata.type": "microsoft.graph.root" },
"settings": { "@odata.type": "microsoft.graph.sitesettings" },
"shareByEmailEnabled": "Boolean",
"sharepointIds": { "@odata.type": "microsoft.graph.sharepointIds" },
"siteCollection": {"@odata.type": "microsoft.graph.siteCollection"},
"template": "String",
/* relationships */
"analytics": { "@odata.type": "microsoft.graph.itemAnalytics" },
"columns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"contentTypes": [ { "@odata.type": "microsoft.graph.contentType" }],
"extensions": [ { "@odata.type": "microsoft.graph.extension" }],
"externalColumns": [ { "@odata.type": "microsoft.graph.columnDefinition" }],
"drive": { "@odata.type": "microsoft.graph.drive" },
"drives": [ { "@odata.type": "microsoft.graph.drive" }],
"items": [ { "@odata.type": "microsoft.graph.baseItem" }],
"lists": [ { "@odata.type": "microsoft.graph.list" }],
"permissions": [ { "@odata.type": "microsoft.graph.permission" }],
"sites": [ { "@odata.type": "microsoft.graph.site"} ],
"termStore": { "@odata.type": "microsoft.graph.termStore.store" },
/* inherited from baseItem */
"createdDateTime": "datetime",
"description": "string",
"eTag": "string",
"lastModifiedDateTime": "datetime",
"name": "string",
"webUrl": "url"
}