Versions Compared

Key

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

In this article

...

  • 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

...

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.

...

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.

Warning

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

...

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

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

...