Versions Compared

Key

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

In this article

Table of Contents
minLevel1
maxLevel3

...

SharePoint Online - Get Sites is a Read-type Snap that provides the ability allows you to get the list of sites specific to the logged-in user (pertaining to the Snap Account) from from the SharePoint Online site. You can also:

  • Retrieve specific metadata information of a specific site.

  • Retrieve the sub-sites of the selected site selected. (Optional)

For more information about how to get the metadata of an item in the SharePoint Online, refer to the list-document-library in Graph API documentation.

...

Field Name

Field Type

Field Dependency

Description

Default Value

Example 

Label*

String

N/A

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

SharePoint Online - Get Sites

Site

String/Expression/Suggestion

Enables Enumerate subsites checkbox.

Specify the name of a site to get the metadata information.

N/A

MySite

Enumerate subsites

Checkbox

Enabled when you specify or select a value in the Site field.

Select this checkbox to get a collection of subsites available for a site.

Not selected

 N/A

Search query*

String/Expression

Enabled when you select the Enumerate subsites checkbox.

Specify keywords that match with one or more site names, as needed. The Snap searches and returns matching sites.

This field is hidden if you select a specific site to retrieve the metadata information.

*

micro*

dev AND (performance OR process) NOT sales

Top

Integer/Expression

Enabled when you select the Enumerate subsites checkbox.

Specify the number of records to be read from the matched search results.

200

500

Auto pagination

Checkbox

N/A

Select this checkbox to retrieve all matching site names as a paginated list.

If you select the Auto Pagination checkbox, the Top field is hidden.

Not selected

 Selected

Connection details

Use this field set to define connection parameters to access SharePoint Online. This field set contains the following fields:

  • Connection timeout

  • Number of retries

  • Retry interval (seconds)

Connection timeout*

Integer

N/A

Specify the connection timeout duration in seconds.

30

30

Number of retries*

Integer

N/A

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

1

3

Retry interval (seconds)*

Integer

N/A

Specify the time interval in seconds between connection attempts.

0

10

Snap Execution

Dropdown list

N/A

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Execute only

Validate & Execute

...