Search
Description
Search step performs search in the Document Library present in a specified site in SharePoint Online.
API Reference:
https://learn.microsoft.com/en-us/graph/api/list-list?view=graph-rest-1.0&tabs=http
Prerequisites
You require the following permissions for app on Azure:
Permissions
| Permission Type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
| Delegated (personal Microsoft account) | Files.Read, Files.ReadWrite, Files.Read.All, Files.ReadWrite.All |
| Application | Files.Read.All, Files.ReadWrite.All, Sites.Read.All, Sites.ReadWrite.All |
Configuration
| No. | Field Name | Description |
|---|---|---|
| 1 | Step Name | Specify name of the step. This name has to be unique in a single workflow. This is a mandatory step. |
| Connection: | ||
| 2 | Client ID | Specify the Client ID of SharePoint App. For information about creating a client ID, see Appendix: SharePoint: App Registration & Refresh Token Generation. The field data type is String. This is a mandatory field. |
| 3 | Accept value as variable/static | Select the checkbox if you want enter the Refresh Token name in the Refresh Token field. If you do not select the checkbox, then you can select the refresh token in the Refresh Token field. |
| 4 | Refresh Token | Specify or select the Refresh Token generated using ClientID, which is generated after creating App in Azure AD. This is a mandatory field. |
| 5 | Test Connection | Verifies whether the connection is established or not. Note: This connection will not work for the previous step variables. The button will only work with static values and environment variables. |
Input Tab
| No. | Field Name | Description |
|---|---|---|
| 1 | Base Site URL | Specify the SharePoint site-relative URL. Format: {Tenant Name}.sharepoint.com:/{SharePoint Site Path} Example: firstUser.sharepoint.com:/sites/TestingSite This is a mandatory field. Note: For the root site (Communication Site), you do not need to provide the {SharePoint Site Path}. |
| 2 | Document Library Name | Provide the name of the SharePoint Document Library in which the search will be performed. This is a mandatory field. |
| 3 | Query Text | Provide the query text. This text is used to search for items in SharePoint. The search operates on file or folder names. Wildcard search is not supported. This is a mandatory field. |
| 4 | Select Properties | Enter the names of the properties to be fetched. Example: id, name, weburl By default, all properties will be fetched. |
| Table Fields: | ||
| 1 | Sort On | Specify the property name by which to sort the result. Example: name Note: Sort On and Sort Type are passed as one parameter internally in the API call. Therefore, if Sort Type is provided, Sort On must also be specified. |
| 2 | Sort Type | Specify the sorting type. Allowed values: asc, desc |
Output tab:
| No. | Field Name | Description |
|---|---|---|
| Output Field: | ||
| 1 | JSON Output | Specify a field to define the output variable name. The default output variable name is “JSONOutput”. On successful execution, it holds the output of the plugin step in JSON format. |