Searching for SharePoint Documents in SharePoint Libraries

In this article

You can search for SharePoint documents in the specified SharePoint document library.

Request

POST https://<hostname>:4443/v6/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Libraries/{libraryId}/search

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be specified in the URL of the request:

Parameter	Type	Description
restoreSessionId	string	Specifies the identification number of the restore session. For more information on how to get this parameter, see Getting Restore Sessions.
siteId	string	Specifies the identification number of the SharePoint site. For more information on how to get this parameter, see Getting Organization SharePoint Sites.
libraryId	string	Specifies the identification number of the SharePoint document library. For more information on how to get this parameter, see Getting SharePoint Libraries.

Request Body

The request body must contain the following property:

Property	Type	Description
query	string	Specifies query parameters used to search for SharePont documents. For more information, see Query Parameters.

Query Parameters

The following table lists examples of parameters that you can use in the query string to search for Microsoft SharePoint documents.

For the complete list of supported query parameters, see Appendix A. Item Search Parameters.

Parameter	Type	Description
filename	string	Specifies the name (or part of the name) of the document that you want to find.
size	string	Specifies the size of the document that you want to find.

Request Example

Request:

POST https://abc.tech.local:4443/v6/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/Organization/Sites/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9/Libraries/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6/search

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"query": "filename:Video"

}

Searching for SharePoint Documents in SharePoint Libraries Note

If a value for a query parameter contains a space, provide the value in the quotation marks (""). Use the backslash (\) symbol as an escape character before these quotation marks. For example: "query": "filename: \"Video Preview\"".

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response body contains the following properties:

Property	Type	Description
offset	integer	Specifies the offset value.
limit	integer	Specifies the limit of records to be displayed on the page.
results	Results Object	Contains the Results object.

Results Object

Property	Type	Description
sizeBytes	string	Specifies the size of the document in Bytes.
version	string	Specifies the version of the item.
id	string	Specifies the item ID.
name	string	Specifies the name of the item.
createdBy	string	Specifies the name of the user who created the item.
creationTime	UTC	Specifies the date and time when the item was created.
modifiedBy	string	Specifies the name of the user who performed the latest modification of the item.
modificationTime	UTC	Specifies the date and time of the latest modification of the item.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

Response Example

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"results": [

{

"sizeBytes": 7110,

"version": "1.0",

"id": "7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6b97a2e61-65cb-48d7-81ab-fe1ca0eb8b50",

"name": "VideoPreview.png",

"createdBy": "System Account",

"creationTime": "2022-02-08T15:44:10",

"modifiedBy": "System Account",

"modificationTime": "2022-02-08T15:44:10",

"_links": {

"self": {

"href": "/v6/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9/documents/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6b97a2e61-65cb-48d7-81ab-fe1ca0eb8b50"

"parent": {

"href": "/v6/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9/folders/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6f129a552-1e68-4ae6-9a6f-6c991fe832dd"

"library": {

"href": "/v6/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9/libraries/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6"

}

"_links": {

"self": {

"href": "/v6/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/Organization/Sites/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9/Libraries/7a780e6e-46be-4735-b542-aa7c4758e53d4774e7df-5416-47d1-8f69-ae4d92e582e9012f2568-838b-4621-8d55-1c2c3d4c49f6/search?offset=0&limit=30"

}