SharePoint Online - Item Children

In this article

Overview

This Snap provides the ability to get the metadata of items from the selected SharePoint Online document library. It fetches the children of an item. It is possible to 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.

Prerequisites

  • Use valid SharePoint Online tenant and associated site in account and snap settings respectively.
  • Valid application in Azure portal with necessary permissions to the application. To learn more, including how to choose permissions, see Permissions.

Support for Ultra Pipelines

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

N/A 

Snap Input and Output


Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A document containing the metadata of the folder for which the children items need to be retrieved.


Output

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A document containing the metadata information of the children of the configured folder.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

Label

String

Required. 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 - Item Children

Site

String

Required.  This property enables you to define the name of a site, which contains the list of document library to be used in the subsequent settings.

N/A

MySite

Document Library

String

Required. This property enables you to select 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 dropdown. Users are allowed either to choose a document library from suggestion dropdown or type an entity manually.

If an expression is used in the Site property, then the document library cannot be suggested. 

N/A

Shared Documents

Source item relative path

String

Optional. The driveItem resource path that represents a folder 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/A

testFile.pdf

Select fields

StringOptional. Enter the field names of the metadata that should be returned to the output view.N/Aname, id
Orderby propertiesN/A

Optional: Enter these properties to perform the order of the result set.

disabled

Property name

StringEnter the name of the property to be sorting order.N/Aname
       Order typeDropDownSelect the appropriate sort order to be performed upon the selected itemsascN/A
TopintOptional. Use this property to set the page size of results.200500
Top Auto pagination
boolean

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

DisabledN/A

Connection details

N/ASettings to influence connection properties to the SharePoint Online APIs.N/AN/A

Connection timeout

intRequired. This property enables you to set the connection timeout duration in seconds.3030

Number of retries

intRequired. This property enables you to set the maximum number of re-connections in case of connection failure or timeout.351

Retry interval (seconds)

intRequired. This property enables you to set the time interval in seconds between connection attempts.1020

Snap Execution

DropDown

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

N/A

For more information on how to list the children of a folder and document library in the SharePoint Online please refer to the graph API, see drive-list-children.

Troubleshooting

ErrorReasonResolution
HTTP Response Code:404

Entered item not found in the document library

Please ensure to provide the valid item path to get the metadata.

Forbidden exception:403Either user or app doesn't have sufficient permissions to read the metadata for the document library.Ensure to provide the desired permissions both at the user and application level.
Internal Server Error: 501Value for the Property name might have missed.Please ensure to provide the value for the property name in the order by property.

Examples

The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

The following SharePoint Online - Item Children snap and pipeline shows how to get item children files in the source folder.


The configuration of the SharePoint Online - Item Children Items snap is shown below. The Snap specifies how to get the children of a provided folder and sort them based on their names.



A successful validation or execution of the Snap gives the following output preview, showing the results.



Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Furnish Pipeline parameters as applicable.

  File Modified

File SP_1.0.0_GetItemChildren_2020_05_29.slp

Jun 04, 2020 by Rojo Publisher

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'EXPORTSPACE:SharePoint Online Snap Pack'.


See Also