In this article
...
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.
Prerequisites
- Valid SharePoint Online tenant and associated site.
- Valid Azure application with all the required API permissions.
...
- Works in Ultra Pipelines.
To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
...
Parameter Name | Data Type | Description | Default Value | Example | ||
---|---|---|---|---|---|---|
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 Pipeline. | N/A | SharePoint Online - Get Document Library | ||
Site | String | Required. The name of a site that contains the list of document library to be used in the subsequent settings. | N/A | MySite | ||
Custom Site Path | Check-box | Enable this option if your site-URL contains a custom path that deviates from the default site-URL: https://{tenantName}.sharepoint.com/sites/{siteName}. | Not Selected | Selected | ||
Document Library | String | Optional. 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. You can either choose a document library from the suggestion drop-down list or enter the entity name manually. If this property doesn’t have a value then by default the snap will get the metadata of all document libraries within the site.
| N/A | Shared Documents | ||
Select fields | String | Optional. Enter the comma-separated list of properties to be returned to the output view. | N/A | id, name | ||
Orderby properties | Optional. Enter the properties and order they want to be displayed when found more one item with one or more similar properties. This fieldset comprises the following fields:
| |||||
Property name | String | Enter the attribute name of the item/drive/folder to be sorted. | N/A | name | ||
Order type | String | Select the appropriate order type to perform the sorting at the server-side. | asc | desc | ||
Top | Integer | Sets the page size of results. | N/A | 50 | ||
Auto pagination | Check box | Optional. Enable to get the complete result set of the items | 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 | Integer | Required. Enables you to set the connection timeout duration in seconds. | 30 | 30 | ||
Number of retries | Integer | Required. Enables you to set the maximum number of retries in case of connection failure or timeout. | 3 | 3 | ||
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 10 | 10 | ||
Snap Execution | String | Specify the required Pipeline execution type:
| Execute only | Validate & Execute |
...
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.
...