Поиск элементов DriveItem в объекте driveSearch for a DriveItems within a drive

Поиск элементов, соответствующих запросу, в иерархии элементов.Search the hierarchy of items for items matching a query. Вы можете выполнить поиск в иерархии папок, на всем диске или среди файлов, к которым предоставлен доступ текущему пользователю.You can search within a folder hierarchy, a whole drive, or files shared with the current user.

РазрешенияPermissions

Для вызова этого API требуется одно из указанных ниже разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Тип разрешенияPermission type Разрешения (в порядке повышения привилегий)Permissions (from least to most privileged)
Делегированные (рабочая или учебная учетная запись)Delegated (work or school account) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All
Делегированные (личная учетная запись Майкрософт)Delegated (personal Microsoft account) Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.AllFiles.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All
Для приложенийApplication Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.AllFiles.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All

HTTP-запросHTTP request

GET /drives/{drive-id}/root/search(q='{search-text}')
GET /groups/{group-id}/drive/root/search(q='{search-text}')
GET /me/drive/root/search(q='{search-text}')
GET /sites/{site-id}/drive/root/search(q='{search-text}')
GET /users/{user-id}/drive/root/search(q='{search-text}')

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

Этот метод поддерживает параметры запросов OData $expand, $select, $skipToken, $top и $orderby для настройки ответа.This method supports the $expand, $select, $skipToken, $top, and $orderby OData query parameters to customize the response.

Параметры функцииFunction parameters

ИмяName ЗначениеValue ОписаниеDescription
q stringstring Текст запроса, используемый для поиска элементов. Для поиска можно использовать несколько полей, включая поля имени файла, метаданных и содержимого файла.The query text used to search for items. Values may be matched across several fields including filename, metadata, and file content.

ПримерExample

ЗапросRequest

Вот пример запроса, выполняющего поиск в хранилище OneDrive текущего пользователя.Here is an example of the request searching the current user's OneDrive

GET /me/drive/root/search(q='{search-query}')

ОткликResponse

Этот метод возвращает объект, который содержит коллекцию элементов DriveItem, соответствующих условиям поиска. Если не будет найдено ни одного элемента, то будет возвращена пустая коллекция.This method returns an object containing an collection of DriveItems that match the search criteria. If no items were found, an empty collection is returned.

Если будет найдено слишком много совпадений, отклик будет разбит на страницы, а свойство **@odata.nextLink** будет содержать URL-адрес на следующую страницу с результатами. Чтобы указать количество элементов на странице, вы можете использовать параметр запроса $top.If there are too many matches the response will be paged and an **@odata.nextLink** property will contain a URL to the next page of results. You can use the $top query parameter to specify the number of items in the page.

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

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}

Поиск элементов, к которым пользователь может получить доступSearching for items a user can access

Помимо поиска элементов на диске ваше приложение может выполнять более широкий поиск и включать элементы, к которым текущему пользователю предоставлен доступ. Чтобы расширить область поиска, используйте метод search в ресурсе Drive.In addition to searching for items within a drive, your app can search more broadly to include items shared with the current user. To broaden the search scope, use the search method on the Drive resource.

ПримерExample

GET /me/drive/search(q='{search-query}')

ОткликResponse

Отклики при поиске на ресурсе Drive могут включать элементы, расположенные за пределами диска (элементы, к которым текущему пользователю предоставлен доступ). Эти элементы будут содержать аспект remoteItem, который указывает, что они хранятся не на целевом диске.Responses when searching from the drive resource may include items outside of the drive (items shared with the current user). These items will include the remoteItem facet to indicate they are stored outside of the target drive.

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

{
    "value": [
      {
        "id": "0123456789abc!123",
        "name": "Contoso Project",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!123" },
        "remoteItem": { "id": "!23141901", "parentReference": { "driveId": "s!1020101jlkjl12lx" } }
      },
      {
        "id": "0123456789abc!456",
        "name": "Contoso Project 2016",
        "folder": {},
        "searchResult": { "onClickTelemetryUrl": "https://bing.com/0123456789abc!456" }
      }
    ],
    "@odata.nextLink": "https://graph.microsoft.com/v1.0/me/drive/root/search(query='contoso project')&skipToken=1asdlnjnkj1nalkm!asd"
}

ПримечанияRemarks

Примечание. Если в OneDrive для бизнеса и SharePoint поиск выполняется в иерархии папок, файлы изображений могут не возвращаться в результатах.Note: In OneDrive for Business and SharePoint, when searching under a folder hierarchy, image file types, may not be returned in the results.

Ответы с ошибкамиError responses

Дополнительные сведения о том, как возвращаются ошибки, см. в статье Ошибки.See Error Responses for more information about how errors are returned.