You can use this Snapto 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.
ValidSharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
An input document contains the metadata information that needs to get the document library metadata.
An output document contains the metadata of the document library or complete list of document libraries in the mentioned site.
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.
SharePoint Online - Get Document Library
Required. The name of a site that contains the list of document library to be used in the subsequent settings.
Custom Site Path
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.
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.
If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception..
Optional. Enter the comma-separated list of properties to be returned to the output view.
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:
Enter the attribute name of the item/drive/folder to be sorted.
Select the appropriate order type to perform the sorting at the server-side.
Sets the page size of results.
Optional. Enable to get the complete result set of the items
You can use this fieldset to influence connection properties to the SharePoint Online APIs.
This fieldset comprises the following fields:
Retry interval (seconds)
Required. Enables you to set the connection timeout duration in seconds.
Number of retries
Required. Enables you to set the maximum number of retries in case of connection failure or timeout.
Retry interval (seconds)
Required. Enables you to set the time interval in seconds between connection attempts.
Specifytherequired 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.
Validate & Execute
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.
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.
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.
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.