Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

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

Excerpt

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

...

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.

...