Получение ресурса Drive

В этой статье рассказывается, как получить свойства и связи ресурса Drive.

Drive — это контейнер верхнего уровня для файловой системы, например OneDrive или библиотек документов SharePoint.

Разрешения

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

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

Получение хранилища OneDrive текущего пользователя

Доступ к диску пользователя, выполнившего вход в систему (при использовании делегированной проверки подлинности), можно получить из одноэлементного множества me.

Если хранилище OneDrive пользователя не подготовлено к работе, но у пользователя есть лицензия на использование OneDrive, то в результате выполнения этого запроса будет автоматически подготовлен диск пользователя (при использовании делегированной проверки подлинности).

HTTP-запрос

GET /me/drive

При использовании прямой конечной точки службы OneDrive исключите сегмент /me.

GET /drive

Получение хранилища OneDrive пользователя

Чтобы получить доступ к хранилищу OneDrive или OneDrive для бизнеса пользователя, ваше приложение должно запросить связь drive в ресурсе User.

Если хранилище OneDrive пользователя не подготовлено к работе, но у пользователя есть лицензия на использование OneDrive, то в результате выполнения этого запроса будет автоматически подготовлен диск пользователя (при использовании делегированной проверки подлинности).

HTTP-запрос

GET /users/{idOrUserPrincipalName}/drive

Параметры пути

Имя параметра Значение Описание
idOrUserPrincipalName строка Обязательный. Идентификатор объекта пользователя, которому принадлежит хранилище OneDrive.

Получение библиотеки документов, связанной с группой

Чтобы получить доступ к библиотеке документов, используемой по умолчанию, для группы, ваше приложение должно запросить связь drive в объекте Group.

HTTP-запрос

GET /groups/{groupId}/drive

Параметры пути

Имя параметра Значение Описание
groupId строка Обязательный. Идентификатор группы, которой принадлежит библиотека документов.

Получение библиотеки документов для сайта

Чтобы получить доступ к библиотеке документов, используемой по умолчанию, для сайта, ваше приложение должно запросить связь drive в объекте Site.

HTTP-запрос

GET /sites/{siteId}/drive

Параметры пути

Имя параметра Значение Описание
siteId строка Обязательный. Идентификатор для сайта, который содержит библиотеку документов.

Получение диска с использованием его идентификатора

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

HTTP-запрос

GET /drives/{drive-id}

Параметры пути

Имя параметра Значение Описание
driveId string Обязательный. Идентификатор запрошенного диска.

Необязательные параметры запросов

Эти методы поддерживают параметр запроса $select для формирования ответа.

HTTP-отклик

Каждый из этих методов возвращает ресурс Drive для соответствующего диска в тексте отклика.

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

{
    "id": "b!t18F8ybsHUq1z3LTz8xvZqP8zaSWjkFNhsME-Fepo75dTf9vQKfeRblBZjoSQrd7",
    "driveType": "business",
    "owner": {
        "user": {
            "id": "efee1b77-fb3b-4f65-99d6-274c11914d12",
            "displayName": "Ryan Gregg"
        }
    },
    "quota": {
        "deleted": 256938,
        "fileCount": 2,
        "remaining": 1099447353539,
        "state": "normal",
        "total": 1099511627776
    }
}

Коды ответов с ошибками

Если диск не существует, и не удается подготовить его к работе автоматически (при использовании делегированной проверки подлинности), будет возвращен ответ HTTP 404.