In this article
...
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing the metadata of the list items to be retrieved. |
Output | Document |
|
| A document containing the list items in the selected list. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
...
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: SharePoint Online - List Read Items | String | Specify a unique 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. | |
Site* Default Value: N/A | String/Expression | Specify the name of a site which contains the list of document library to be used in the subsequent Snap settings. | |
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 the prefix ‘site/’ before the sitename, a custom site can contain the prefix ‘team/’ or it can have no prefix. | |
List name* Default Value: N/A | String/Expression | Select a list name from the document library suggestions provided in this field. The suggested list names pertain to the SharePoint Online site specified already. This field cannot provide any document library suggestions when you define Site as as expression. This may result in an exception for suggestions. | |
Filter query Default Value: N/A | String/Expression | Enter the query to filter the retrieved list of items from the selected list when you want to retrieve a set of list items. | |
Select fields Default Value: N/A | String/Expression | Specify the comma-separated field/column names from the metadata to be included to the output view. | |
Expand list items Default Value: N/A | String/Expression | Specify the comma-separated column names of the list to be retrieved from the list. | |
Top Default Value: 200 | Integer/Expression | Specify an integer value to define the number of retrieved list items to be displayed per page (pagination). While providing a value in this field, do not select Auto pagination check box. | |
Auto pagination Default Value: Deselected | Checkbox | Select this checkbox to retrieve all items within the selected folder/directory. If not selected (by default), the Snap returns a maximum of 200 records per page. While selecting this check box, ensure that the Top field is blank. | |
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 | String/Expression | Specify the attribute name of the item/drive/folder to be sorted. | |
Order type Default Value: asc | Dropdown list/Expression | Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:
| |
Connection details | Use this field set to specify connection properties to the SharePoint Online APIs. | ||
Connection Timeout* Default Value: 30 | Integer | Specify the connection timeout duration in seconds. | |
Number of Retries* Default Value: 3 | Integer | Specify the maximum number of reconnections in case of a connection failure or timeout. | |
Retry Interval (seconds)* Default Value: 10 | Integer | Specify the time interval in seconds between connection attempts. | |
Snap Execution Default Value: Validate & Execute | Dropdown list | Specify the required Pipeline execution type:
|
...