SharePoint Online - Search Items

In this article

Overview

You can use this Snap provides the ability to perform a search for the hierarchy of items matching the search query. You can search within a folder hierarchy, a whole drive, or files shared with the current user.

Prerequisites

  • Valid SharePoint Online tenant and associated site.
  • Valid Azure application with all the required API permissions.

Support for Ultra Pipelines

To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser

An input document contains the metadata of the item that can be used in the search item query.


Output

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser

An output document contains the metadata information of items that match the search query.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

Label

String

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your ipeline.

N/A

SharePoint Online - Search Item

Site

String

Required. The name of a site that contains the list of document library to be used in the subsequent Snap settings.

N/A

MySite

Custom Site PathCheck-boxEnable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has a prefix ‘sites/’ before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefix.Not SelectedSelected

Document Library

String

Required. This property enables you to select a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field populates dynamically from different sites via the suggestion drop-down list. You can either choose a document library from suggestion drop-down or enter the entity name manually.

If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

N/A

Shared Documents

Source item relative path

String

Optional. The item resource path that represents a folder stored in a document library. If this property is left empty then the search will be performed at the document library level.

N/A

testFile.pdf
Search queryStringOptional. Specify keywords to be searched. It searches the filenames and content of files in SharePoint Online and finds matching documents.N/Apdf

Select fields

StringOptional. Enter the comma-separated property names to be returned in the results.N/Aname, id
Orderby properties

Optional: Enter these properties to perform the order of the result set. The two types of properties are listed below:

  • Property name
  • Order type

Property name

StringEnter the name of the property to be sorting order.N/Aname
Order typeStringSelect the appropriate sort order to be performed upon the selected items. 

Available options are:

  • asc
  • desc
ascdesc
TopIntegerOptional. Use this property to set the page size of results.200500
Auto paginationCheck boxOptional. To get all items within a single folder item/document directory. If this field is not checked, SharePoint Online will return a maximum of 200 records per page by default. If this field is selected, all matching records will be automatically returned.Not selected

Connection details

You can use this fieldset to influence connection properties to the SharePoint Online APIs.

This fieldset comprises the following fields:

  • Connection timeout
  • Number of retries
  • Retry interval (seconds)

Connection timeout

IntegerRequired. Enables you to set the connection timeout duration in seconds.3030

Number of retries

IntegerRequired. Enables you to set the maximum number of re-connections in case of connection failure or timeout.31

Retry interval (seconds)

IntegerRequired. Enables you to set the time interval in seconds between connection attempts.1010

Snap Execution

String

Specify the required Pipeline execution type:

  • Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap.(unlimited records) during Pipeline execution.

  • Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled. Disables the Snap and, by extension, its downstream Snaps.

Execute only

Validate & Execute

For more information on how to delete an item in the SharePoint Online, refer to the graph API in driveItem-search.

Troubleshooting

ErrorReasonResolution
HTTP Response Code:404

Entered item not found in the document library

Ensure to provide the valid item path to get the metadata.

Forbidden exception:403Either user or app doesn't have sufficient permissions to read the metadata for the document library.Ensure to provide the desired permissions both at the user and application level.
Internal Server Error: 501Value for the Property name might have missed.Ensure to provide the value for the property name in the Orderby properties.

Examples

Searching for PDF files

This example demonstrates how to search for PDF files in the document library. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

The following screenshot displays the settings of the SharePoint Online - Search Items. This Snap searches all PDFs available in the selected document library and order the output documents based on the item name.

After successfully validating/executing the above Snap, the results display in the following output preview.

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Furnish Pipeline parameters as applicable.

  File Modified

File Example_sharepoint_Search_Items.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

4.29main108 StableUpgraded with the latest SnapLogic Platform release.
4.28 Patchesmain101 LatestFixed the Auto Refresh Token issue in the SharePoint Online Account.
4.28main100 StableAdded the SharePoint Online - Get Sites Snap that enables you to get the list of sites specific to the logged-in user from the SharePoint Online site.
4.27main93 StableUpgraded with the latest SnapLogic Platform release.
4.26main89 LatestEnhanced all Snaps in the SharePoint Online Snap Pack to support dynamic site and document library values using input document variables.
4.26main88 StableUpgraded with the latest SnapLogic Platform release.
4.25main75 StableNo updates made.
4.24main75 StableNo updates made.
4.23main74 LatestFixes the error view issue in SharePoint Online - Upload File Snap by dragging a new instance of SharePoint Online - Upload File Snap to the canvas as the existing Snap that was used with a version that contained the bug will continue to fail.
4.23main74 Latest

Fixes the socket timeout issue in the Snap Pack by making the following changes:

  • Modifies the code to return the ProxyHttpClient instead of the basic HTTP client and handle the custom siteName.
  • Fixes the broken JUnit and code for pagination in the SharePoint Online - List Read Items Snap.
4.23main73 LatestIntroduces a new Snap, SharePoint Online - List Read Items Snap, that enables you to read, sort, and filter list items from your SharePoint Online libraries/collections.
4.22 Patchesmain39 StableFixes the Snap document link for SharePoint Online - List Read Items.
4.22-Patches422patches6694 Latest
  • Fixes the List Read Snap NPE(null pointer exception) failure, when the List Name field is empty.
  • Fixes the Search Items Snap issue by providing the same result set when more than one document is passed.
4.22main6403 Stable

No updates made.

4.21-Patches421patches6011 
  • Latest
  • Stable
Introduces the productized version of SharePoint Online Snap Pack, which enables organizations to share and manage content and collaborate across an organization

4.21

snapsmrc535

 

Latest

Beta release of the SharePoint Online Snap Pack


See Also