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 Example: MySite		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
Document Library Default Value: N/A Example: Shared 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 Example: id, 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 Example: name	String	Specify the attribute name of the item/drive/folder to be sorted.
	Order type Default Value: asc Example: desc	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 Example: 50	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 Example: 40	Integer	Specify the connection timeout duration in seconds.
	Number of Retries* Default Value: 3 Example: 5	Integer	Specify the maximum number of reconnections in case of a connection failure or timeout.
	Retry Interval (seconds)* Default Value: 10 Example: 11	Integer	Specify the time interval in seconds between connection attempts.
Snap Execution Default Value: Validate & Execute Example: Execute 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.