In this article
...
- Works in Ultra Pipelines.
To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
Limitations and Known Issues
None.
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| An input document contains the metadata of the folder for which the children items need to be retrieved. |
| Output | Document |
|
| An output document contains the metadata information of the children of the configured folder. |
...
| Parameter Name | Data Type | Description | Default Value | Example | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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. The name of a site that contains the list of document library to be used in the subsequent Snap settings. | N/A | MySite | ||||||||||||
| Custom Site Path | Check-box |
| Not Selected | Selected | ||||||||||||
Document Library | String | Required. This property enables you to select a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field populates dynamically from different sites via the suggestion drop-down. You can either choose a document library from suggestion drop-down list or enter the entity name manually.
| N/A | Shared Documents | ||||||||||||
Source item relative path | String | Optional. The item 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 | String | Optional. Enter the field names of the metadata that should be returned to the output view. | N/A | name, id | ||||||||||||
| Orderby properties | Optional. Enter these properties to perform the order of the result set. This fieldset comprises the following fields:
| |||||||||||||||
Property name | String | Enter the name of the property to be sorting order. | N/A | name | ||||||||||||
| Order type | String | Select the appropriate sort order to be performed upon the selected items | asc | N/A | ||||||||||||
| Top | Integer | Optional. Use this property to set the page size of results. | 200 | 500 | ||||||||||||
Top Auto pagination | Check box | 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. | Not selected | N/A | ||||||||||||
Connection details | You can use this fieldset to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields:
| |||||||||||||||
Connection timeout | Integer | Required. Enables you to set the connection timeout duration in seconds. | 30 | 30 | ||||||||||||
Number of retries | Integer | Required. Enables you to set the maximum number of reconnections in case of a connection failure or timeout. | 3 | 51 | ||||||||||||
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 10 | 20 | ||||||||||||
Snap Execution | String | Specify the required Pipeline execution type:
| Execute only | Validate & Execute | ||||||||||||
...
This example demonstrates 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).
The following screenshot displays the settings of the SharePoint Online - Item Children Snap. The Snap specifies on how to get the children of a provided folder and sort them based on their names.
...