In this article
Overview
You can use this Snap to get the metadata of an item from the SharePoint Online document library. Also, you can retrieve specific fields in the metadata of a document library by submitting the comma-separated field names in the select property.
Snap Type
SharePoint Online - Get Document Library Snap is a Read-type Snap.
Prerequisites
Valid SharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
Support for Ultra Pipelines
Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. 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 Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| An input document contains the metadata information that needs to get the document library metadata. |
Output | Document |
|
| An output document contains the metadata of the document library or complete list of document libraries in the mentioned site. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: SharePoint Online - Get Document Library | String | Specify 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 Pipeline. | |
Site* Default Value: N/A | String/Expression | Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings. | |
Custom Site Path Default Value: Deselected | Checkbox | Enable 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. | |
Document Library Default Value: N/A | String/Expression | Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list 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. | |
Select fields Default Value: N/A | String/Expression | Specify the comma-separated list of properties to be returned to the output view. | |
Order by Properties | Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties. | ||
Property name Default Value: N/A | String | Specify the attribute name of the item/drive/folder to be sorted. | |
Order type Default Value: asc | Dropdown list/Expression | Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:
| |
Top Default Value: N/A | Integer/Expression | Specify the page size of results. | |
Auto pagination Default Value: Deselected | Checkbox | Select to get the complete result set of the items. | |
Connection details | Use this field set to specify connection properties to the SharePoint Online APIs. | ||
Connection Timeout* Default Value: 30 | Integer | Specify the connection timeout duration in seconds. | |
Number of Retries* Default Value: 3 | Integer | Specify the maximum number of reconnections in case of a connection failure or timeout. | |
Retry Interval (seconds)* Default Value: 10 | Integer | Specify the time interval in seconds between connection attempts. | |
Snap Execution Default Value: Validate & Execute | Dropdown list | Specify the required Pipeline execution type:
|
For more information on how to get the metadata of an item in the SharePoint Online, refer to the graph API in list-document-library.
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Either source/target drive (WrongDriveName) is not found in the tenant | Entered document library might not be available in the tenant | Click the suggestion drop-down button and select the entity or enter the existing one manually. |
Forbidden exception | Either 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. |
Examples
Retrieving Document Library
This example demonstrates how to retrieve the document library metadata of a site. The example assumes that you have configured and authorized a valid SharePoint Online Account (see SharePoint Online Account).
The following screenshot displays the settings of the SharePoint Online - Get Document Library Snap to get document library metadata.
After successfully validating/executing the above Snap, the results display in the following output preview.
Downloads
Important Steps to Successfully Reuse Pipelines
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Furnish Pipeline parameters as applicable.
Release | Snap Pack Version | Date | Type | Updates |
---|---|---|---|---|
August 2024 | main180 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
May 2024 | main175 |
| Latest |
|
May 2024 | main172 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
February 2024 | main168 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
November 2023 | main155 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
August 2023 | main150 |
| Latest | Added pagination in the List Read Items Snap. Also added suggestions for the List name field. |
August 2023 | main144 |
| Latest | The Upload File Snap now supports files larger than 2 GB. |
August 2023 | main138 |
| Stable | Updated and certified against the current SnapLogic Platform release. |
May 2023 | main130 |
| Stable | Upgraded with the latest SnapLogic Platform release. |
February 2023 | main114 | 09 Feb 2023 | Stable | Upgraded with the latest SnapLogic Platform release. |
November 2022 | main113 | 10 Nov 2022 | Stable | Upgraded with the latest SnapLogic Platform release. |
August 2022 | main111 | 11 Aug 2022 | Stable | Added the SharePoint Online Application Account type that supports Client Credentials flow. |
4.29 | main108 | 14 May 2022 | Stable | Upgraded with the latest SnapLogic Platform release. |
4.28 Patches | main101 | 06 Apr 2022 | Latest | Fixed the Auto Refresh Token issue in the SharePoint Online Account. |
4.28 | main100 | 12 Feb 2022 | Stable | Added 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.27 | main93 | 13 Nov 2021 | Stable | Upgraded with the latest SnapLogic Platform release. |
4.26 | main89 | 30 Aug 2021 | Latest | Enhanced all Snaps in the SharePoint Online Snap Pack to support dynamic site and document library values using input document variables. |
4.26 | main88 | 14 Aug 2021 | Stable | Upgraded with the latest SnapLogic Platform release. |
4.25 | main75 | 08 May 2021 | Stable | No updates made. |
4.24 | main75 | 13 Feb 2021 | Stable | No updates made. |
4.23 | main74 | 02 Dec 2020 | Latest | Fixes 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.23 | main74 | 16 Nov 2020 | Latest | Fixes the socket timeout issue in the Snap Pack by making the following changes:
|
4.23 | main73 | 15 Nov 2020 | Latest | Introduces 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 Patches | main39 | 23 Oct 2020 | Stable | Fixes the Snap document link for SharePoint Online - List Read Items. |
4.22-Patches | 422patches6694 | 14 Sep 2020 | Latest |
|
4.22 | main6403 | 08 Aug 2020 | Stable | No updates made. |
4.21-Patches | 421patches6011 | 23 Jun 2020 |
| Introduces the productized version of SharePoint Online Snap Pack, which enables organizations to share and manage content and collaborate across an organization |
4.21 |
| 10 May 2020 | Latest | Beta release of the SharePoint Online Snap Pack |
See Also
- Configuring SharePoint Online Account
- SharePoint Online - Copy Item
- SharePoint Online - Create Folder
- SharePoint Online - Create Item Permission
- SharePoint Online - Create List
- SharePoint Online - Delete Item
- SharePoint Online - Delete Item Permission
- SharePoint Online - Delete List Item
- SharePoint Online - Download File
- SharePoint Online - Get Document Library
- SharePoint Online - Get Item
- SharePoint Online - Get Item Permissions
- SharePoint Online - Get Sites
- SharePoint Online - Item Children
- SharePoint Online - List Read Items
- SharePoint Online - Read List
- SharePoint Online - Search Items
- SharePoint Online - Update Item
- SharePoint Online - Update Item Permission
- SharePoint Online - Update List Item
- SharePoint Online - Upload File