Searching for SharePoint Items in SharePoint Sites

In this article

    This section explains how to search for SharePoint items of the specified SharePoint site.

    Request

    POST https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/action

    Request Headers

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

    Request Parameters

    The request URL must contain the following parameters:

    Parameter

    Type

    Description

    restoreSessionId

    string

    Specifies the identification number of the restore session. Can be obtained as described in Getting Restore Sessions.

    siteId

    string

    Specifies the identification number of the SharePoint site. Can be obtained as described in Getting SharePoint Sites.

    Request Body

    The request body must contain the search action property:

    Property

    Type

    Description

    query

    string

    Specifies query parameters used to search for SharePont items. 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 items.

    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 item that you want to find.

    size

    string

    Specifies the size of the item that you want to find.

    subject

    string

    Specifies the subject of the item that you want to find.

    title

    string

    Specifies the title of the item that you want to find.

    Request Example

    Request:

    POST https://delta.tech.local:4443/v5/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/Organization/Sites/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c/action

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Request Body:

    {

      "search":{

         "query": "filename:sub2"

      }

    }

     

    Searching for SharePoint Items in SharePoint Sites 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: \"sub 2\"".

    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

    Property

    Type

    Description

    offset

    integer

    Shows the offset value.

    limit

    integer

    Shows the limit of records to be displayed on the page.

    results

    Results Object

    Contains the Results object.

    Results Object

    Property

    Type

    Description

    title

    string

    Shows the title of the item.

    version

    string

    Shows the version of the item.

    id

    string

    Shows the ID of the item.

    name

    string

    Shows the name of the item.

    createdBy

    string

    Shows the name of the user who created the item.

    creationTime

    datetime

    Shows the date and time when the item was created.

    modifiedBy

    string

    Shows the name of the user who performed the latest modification of the item.

    modificationTime

    datetime

    Shows 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": [

       {

         "title": "sub2 notes",

         "version": "1.0",

         "id": "7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c3eb6e3e5-f4a1-4550-9b03-02d736030bbf540e993f-6b1e-4f30-b186-76e1923f540b",

         "name": "sub2 notes",

         "createdBy": "admin8",

         "creationTime": "2018-03-20T12:20:08",

         "modifiedBy": "admin8",

         "modificationTime": "2018-03-20T12:20:08",

         "_links": {

           "self": {

             "href": "https://delta.tech.local:4443/v5/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c/items/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c3eb6e3e5-f4a1-4550-9b03-02d736030bbf540e993f-6b1e-4f30-b186-76e1923f540b"

           },

           "list": {

             "href": "https://delta.tech.local:4443/v5/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c/lists/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c3eb6e3e5-f4a1-4550-9b03-02d736030bbf"

           },

           "attachments": {

             "href": "https://delta.tech.local:4443/v5/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/organization/sites/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c/items/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c3eb6e3e5-f4a1-4550-9b03-02d736030bbf540e993f-6b1e-4f30-b186-76e1923f540b/attachments"

           }

         }

       }

     ],

     "_links": {

       "self": {

         "href": "https://delta.tech.local:4443/v5/RestoreSessions/c295f84c-7d09-48a8-be74-8730ad1155c3/Organization/Sites/7a780e6e-46be-4735-b542-aa7c4758e53d7491f01f-6d22-4f6c-8abd-102b35cea87c/action?offset=0&limit=30"

       }

     }

    }

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.