In this article

Overview

This Snap provides the ability You can use this Snap to get the metadata of items from the selected SharePoint Online document library. It fetches the children of an item. It is possible to You can also specify the folder name with the property “source item relative path“. If the expand option is enabled and the select fields property is filled, then the specification of the select field will also apply to the children items.

Image Removed

Prerequisites

...

“Source Item Relative Path“ property.

...

Snap Type

SharePoint Online - Item Children is a Read-type Snap that fetches the children of an item.

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.

...

See  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, refer to 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 - Item Children Example: SharePoint Online - Item Children

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

Pipeline.

NSite

Site* Default Value: N/A

SharePoint Online - Item Children

Example: MySite

String

Required. The

/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

Document Library

String

Required. This property enables you to select Drive

Custom Site Path Default Value: Deselected		Checkbox	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 prefiix.
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.

Users are allowed

You can either

to

choose a document library from suggestion drop-down list or

type an

enter the entity name manually.

warning

If

user enables

you enable the

 

Site

 

property as an expression, then the document library

 

is

not suggested. Such a configuration results 

not suggested, resulting in an exception.

N

Source Item Relative Path* Default Value: N/A

Shared Documents

Source item relative path

String

Optional. The item resource

Example: testFile.pdf

String/Expression

Specify the item resource path that represents a file, folder, or other item stored in a

document library to list the children. If this property is left empty, then the items of the

document library

will be retrieved

.

N

Select fields

StringOptional. Enter the field names of the metadata that should be returned

Select fields Default Value: N/A

testFile.pdfOrderby properties

Optional. Enter these properties to perform the order of the result set. This fieldset comprises the following fields:

• Property name
• Order type

Property name

StringEnter

Example: id, email, roles

String/Expression

Enter the comma-separated properties to be written to the output view.

N/Aname, idOrder typeString

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 name of the property to be sorting order.

N/Aname

Order type Default Value: asc Example: desc

Dropdown list/Expression

Select the appropriate sort order to be performed upon the selected items. Avaialble options are: asc

N/A

desc
Top Default Value: 200 Example: 500		Integer

Optional. Use this property to set Top

/Expression

Specify the page size of results.

200500

Auto pagination

Check boxOptional. To

Default Value: Deselected

Checkbox

Select to get all items within a single folder item/document directory. If this field is not checked, SharePoint Online will return a maximum of 200 records per page by default. If this field is selected, all matching records will be automatically returned.

Not selectedN/A

Connection details

Settings to influence

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

This fieldset comprises the following fields:

Required. This property enables you to set

Connection timeout*

Number of retries

Retry interval (seconds)

Connection timeout

Integer

Default Value: 30 Example: 40

Integer

Specify the connection timeout duration in seconds.

3030Required. This property enables you to set

Number of retries*

Integer

Default Value: 3 Example: 5

Integer

Specify the maximum number of

re-connections

reconnections in case of a connection failure or timeout.

351Required. This property enables you to set

Retry interval (seconds)*

Integer

Snap Execution

String

Specifies the

Default Value: 10 Example: 11

Integer

Specify the time interval in seconds between connection attempts.

1020

Snap Execution Default Value: Validate & Execute Example: Execute only

Dropdown list

Specify the required Pipeline execution type: Validate & Execute

: Performs

. 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

. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation. Disabled

: Disables

. Disables the Snap and, by extension, its downstream Snaps.

Execute only

Validate & Execute

Info
For more information on how to list the children of a folder and document library in the SharePoint Online, refer to the graph API

...

in drive-list-children.

Troubleshooting

Examples

Retrieving Item Children Files in the Source Folder

This example demonstrates to you on how to how to get item children files in the source folder. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).Image Removed

...

The configuration following screenshot displays the settings of the SharePoint SharePoint Online - Item Children Snap is shown below. The Snap specifies on how to get the children of a provided folder and sort them based on their names.Image Removed

...

After successful validation or execution of the successfully validating/executing the above Snap,  the the results display in the output 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