Description
Performs a search query against SharePoint. The search will be performed in the area that you specify in the
The
Parameters
| Name | Type | Description |
|---|---|---|
| query | String, required | The search query to send to SharePoint |
| authDetails | Object, optional | The authDetails set in the worker configuration to use. If not set the request will use the default authDetail |
| authDetails.identifier | String | The identifier of authDetails set in the worker configuration |
| authDetails.authType | String | The authType of authDetails set in the worker configuration |
| returnProperties | Array[strings], optional | An array of strings containing the metadata properties you want to retrieve. If not set all properties are returned |
| documentsOnly | Boolean, optional | If |
| rowLimit | Integer, optional | The maximum number of rows to be returned from the search query |
| startRow | Integer, optional | The number of the first row to be returned from the search query |
Example
{
"id": "123",
"jsonrpc": "2.0",
"method": "search",
"params": {
"query": "TestDocument",
"documentsOnly": true,
"startRow": 15,
"rowLimit": 5,
"returnProperties": ["Path", "Title"]
}
}
Last modified on 27 June 2023
Share this page
