In this article
...
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 item to be retrieved, such as, site, item name, etc. |
Output | Document |
|
| An output document contains the metadata information of an item. |
...
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 - Get Item | ||||||||||||
Site | String | Required. The name of a site which 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 will be populated dynamically from different sites from the suggestion drop-down list. 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 | Required. The item resource path that represents a file, folder, or other item stored in a document library. | N/A | testFile.pdf | ||||||||||||
Select fields | String | Optional. Enter the comma-separated properties to be written to the output view. | N/A | |||||||||||||
Expand | Check box | Optional. Used to fetch children items of the folder. This is an optional field which should only be enabled if the Source item relative path property is selected. In case the value of the field Source item relative path is set to file, then this property setting will be ignored. | Not selected | |||||||||||||
Connection details | Settings to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields:
| |||||||||||||||
Connection timeout | Integer | Required. Set the connection timeout duration in seconds. | 30 | 30 | ||||||||||||
Number of retries | Integer | Required. Set the maximum number of reconnections in case of a connection failure or timeout. | 3 | 3 | ||||||||||||
Retry interval (seconds) | Integer | Required. Set the time interval in seconds between connection attempts. | 10 | 10 | ||||||||||||
Snap Execution | String | Specify the required Pipeline execution type:
| Execute only | Validate & Execute |
...
The following screenshot displays the settings of the SharePoint Online - Get Item Snap. The Snap specifies to get the metadata of a folder. It also retrieves the children of the folder.
After successfully validating/executing the above Snap, the results display in the following output preview.
...