This method has been deprecated. Use search instead, which also supports paging.
Description
Searches SharePoint based on your query.
The query parameter contains the query you want to use to search SharePoint. You can supply * as the query to query for everything in the sharepointFolder
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 |
| sharepointFolder | String, optional | The name of a folder to limit the search to |
Example
{
"id": "123",
"jsonrpc": "2.0",
"method": "sharepointSearch",
"params": {
"authDetails": {
"identifier": "GossTest",
"authType": "SAML"
},
"query" : "Uploaded by Worker",
"documentsOnly": true,
"returnProperties" : ["Path", "Title"]
}
}
Last modified on 27 June 2023
Share this page
