Перечисление сайтов

Статья
04/08/2023

Список доступных сайтов в организации, которые соответствуют заданным критериям фильтра и параметрам запроса.

В настоящее время поддерживаются только следующие параметры запроса:

Инструкция Filter	Оператор Select	Описание
`siteCollection/root ne null`	`siteCollection,webUrl`	Список всех семейств веб-сайтов корневого уровня в организации. Полезно для обнаружения домашнего сайта для каждого географического региона.

Кроме того, вы можете использовать поисковый запрос к коллекции "/sites" для поиска сайтов, соответствующих заданным ключевым словам.

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения	Разрешения (в порядке повышения привилегий)
Делегированные (рабочая или учебная учетная запись)	Sites.Read.All, Sites.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)	Не поддерживается.
Для приложений	Sites.Read.All, Sites.ReadWrite.All

HTTP-запрос

GET /sites?filter=siteCollection/root ne null

Пример

Запрос

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

Отклик

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

Поделиться через