In this article

Overview

You can use this Snap 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.Image Removed

...

Snap Type

SharePoint Online - Get Document Library Snap is a Read-type Snap.

Prerequisites

• Valid SharePoint

  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  To know the list of Snaps that work in Ultra and the related caveats, see see Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap

...

Views

Snap Settings

...

Info

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

Example Label

: SharePoint Online - Get Document Library Example: SharePoint Online - Get Document Library

String

Required. The

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.

N

Site

String

Required. The

Site* Default Value: N/A

SharePoint Online - Get Document Library

Example: MySite

String/Expression

Specify the name of a site

that

which contains the list of document library to be used in the subsequent Snap settings.

N/A

MySite

Custom Site Path

Check-box

Default Value: Deselected

Checkbox

Excerpt

-includeSharePoint Online - Get ItemSharePoint Online - Get ItemnopaneltrueNot SelectedSelected

Document Library

String

Optional. This property enables you to select

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

populates

will be populated dynamically from different sites

via

from the suggestion drop-down list. 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. WarningIf

you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.

.NSelect fields

Select fields Default Value: N/A

Shared Documents

Example: id, name

String/Expression

Optional. Enter

Specify the comma-separated list of properties to be returned to the output view.

N/Aid, nameOrderby propertiesOptional. Enter

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.

 This fieldset comprises the following fields:

Property name

Order type

Property

Default Value: N/A Example: name

String

Enter

Order type

String

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

N/Aname

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

Sets

Specify the page size of results.

N/A50Optional. Enable

Auto pagination

Check box

Default Value: Deselected

Checkbox

Select to get the complete result set of the items.

Not selected

Connection details

You can use this fieldset to influence

Use this field set to specify connection properties to the SharePoint Online APIs.

This fieldset comprises the following fields:

Connection

timeout

Number of retries

Retry interval (seconds)

Connection timeout

IntegerRequired. Enables you to set Required. Enables you to set

Timeout* Default Value: 30 Example: 40

Integer

Specify the connection timeout duration in seconds.

3030

Number of retries

Integer

Number of Retries* Default Value: 3 Example: 5

Integer

Specify the maximum number of

retries

reconnections in case of a connection failure or timeout.

33

Retry

interval

Interval (seconds)* Default Value: 10 Example: 11

Integer

Required. Enables you to set

Snap Execution

String

Specify the 

Specify the time interval in seconds between connection attempts.

1010

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.

Execute only

Validate & Execute

Info
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

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).Image Removed

...

The following screenshot displays the settings of the SharePoint Online - Get Document Library Snap to get document library metadata.Image Removed

...

After successfully validating/executing the above Snap, the results display in the following output preview.Image Removed

...

Download this Pipeline. 

Downloads

Snap Pack History

See Also

...

Related Content

...

• Getting Started with SnapLogic

• SharePoint Online Snap Pack

...

• Configuring SharePoint Online Account

• Glossary