3.3.5.2.1 GET

The GET method retrieves the metadata information for search results. The metadata includes basic information such as the creation time, item type, modification time, name, path, and size. The search occurs across all share folders that users have access to.

This operation is transported by an HTTP GET.

The operation can be invoked through the following URI:

 https://<ServerName>/services/builtin/fileoperationservice.svc/items/index/{index}/count/{count}/search?query={query}&sortbyfield={sortbyfield}&ascending={ascending}&scope={scope}&timeoutseconds={timeoutseconds}

The request message for this operation contains the following HTTP headers.

Request header

Usage

Value

Canary

Optional

The value returned in login Response Canary header.

Client MUST either pass this header to the server or pass all of the following headers to the client.  For more details, see section 2.2.2.5.

Authorization

Optional

The caller's credential is encoded text that is based on user name and password. For more details, see section 2.2.2.4.

AppName

Optional

Application name. For more details, see section 2.2.2.1.

AppVersion

Optional

Application version. For more details, see section 2.2.2.3.

AppPublisherName

Optional

Application publisher name. For more details, see section 2.2.2.2.

The response message for this operation can result in the following status codes.

Status code

Description

200

Operation successfully completed.

400

One or more parameters are not valid.

401

Access to the requested resource is denied.

501

Windows search service is not available.

503

Windows search service failed to perform the search.

504

Search does not finish within the specified timeout interval.