SharePoint Online - Get Document Library

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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • File Writer

An input document contains the metadata information that needs to get the document library metadata.



Output

Document

  • Min: 1

  • Max: 1

  • Copy

  • JSON Parser

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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

Field Name

Field Type

Description

Label*

 

Default Value: SharePoint Online - Get Document Library
Example: 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
ExampleMySite

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 ValueDeselected

Checkbox

Document Library

 

Default Value: N/A
ExampleShared Documents

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
Exampleid, name

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
Examplename

String

Specify the attribute name of the item/drive/folder to be sorted.

Order type

 

Default Valueasc
Exampledesc

Dropdown list/Expression

Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:

  • asc

  • desc

Top

 

Default Value: N/A
Example50

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 Value30
Example40

Integer

Specify the connection timeout duration in seconds.

Number of Retries*

 

Default Value3
Example5

Integer

Specify the maximum number of reconnections in case of a connection failure or timeout.

Retry Interval (seconds)*

 

Default Value10
Example11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution

 

Default ValueValidate & Execute
ExampleExecute only

Dropdown list

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.

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

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.

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_Document_Library.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History