Enumerar sites

Artigo
04/08/2023

Liste os sites disponíveis em uma organização que corresponda aos critérios de filtro fornecidos e às opções de consulta.

No momento, há suporte apenas para as seguintes opções de consulta:

Instrução de filtro	Selecionar instrução	Descrição
`siteCollection/root ne null`	`siteCollection,webUrl`	Lista todas as coleções de sites de nível raiz na organização. Útil para descobrir o site inicial de cada geografia.

Além disso, você pode usar uma consulta de pesquisa na coleção '/sites' para encontrar sites correspondentes a determinadas palavras-chave.

Permissões

Uma das permissões a seguir é necessária para chamar essa API. Para saber mais, incluindo como escolher permissões, confira Permissões.

Tipo de permissão	Permissões (da com menos para a com mais privilégios)
Delegado (conta corporativa ou de estudante)	Sites.Read.All, Sites.ReadWrite.All
Delegado (conta pessoal da Microsoft)	Sem suporte.
Aplicativo	Sites.Read.All, Sites.ReadWrite.All

Solicitação HTTP

GET /sites?filter=siteCollection/root ne null

Exemplo

Solicitação

GET /sites?select=siteCollection,webUrl&filter=siteCollection/root%20ne%20null

Resposta

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "id": "contoso.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,712a596e-90a1-49e3-9b48-bfa80bee8740",
      "name": "Contoso USA",
      "root": { },
      "siteCollection": {
        "hostname": "contoso.sharepoint.com",
        "dataLocationCode": "NAM",
        "root": { }
      },
      "webUrl": "https://contoso.sharepoint.com"
    },
    {
      "id": "contoso-jpn.sharepoint.com,da60e844-ba1d-49bc-b4d4-d5e36bae9019,0271110f-634f-4300-a841-3a8a2e851851",
      "name": "Contoso Japan",
      "root": { },
      "siteCollection": {
        "hostname": "contoso-jp.sharepoint.com",
        "dataLocationCode": "JPN",
        "root": { }
      },
      "webUrl": "https://contoso-jp.sharepoint.com"
    }
  ]
}

Compartilhar via