SharePoint Online - Read List
In this article
Overview
You can use this Snap to read the metadata of a list from the SharePoint Online site.
For more information about reading a list in SharePoint Online, refer to the Graph API in list-get.
Snap Type
SharePoint Online - Read List Snap is a Read-type Snap.
Prerequisites
Valid SharePoint Online tenant and associated site.
Valid Azure application with all the required API permissions.
Support for Ultra Pipelines
Works in Ultra Pipelines. However, we recommend that you do not use this Snap in an Ultra Pipeline.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| An input document that contains the metadata of the list to be retrieved. |
Output | Document |
|
| An output document contains the metadata information of a 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. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon (): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon (): Indicates that you can add fields in the field set.
Remove icon (): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description | |
---|---|---|---|
Label*
Default Value: SharePoint Online - Read List | String | Specify 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. | |
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 | ||
List name
Default Value: N/A | String/Expression/Suggestion | 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. | |
Item ID
Default Value: N/A | String/Expression/Suggestion | Specify the unique item ID of the Item to be read. | |
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. | |
Get items
Default Value: Deselected | Checkbox | Select to get the items of the specified list along with the list metadata. | |
Get columns
Default Value: Deselected | Checkbox | Select to get the column metadata along with the list metadata. | |
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. | |
Connection details | Use this field set to configure connection properties for 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:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
HTTP Response Code:404 | Entered item not found in the document library | Ensure to provide the valid item path to get the metadata. |
Forbidden exception:403 | Either the 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. |
Examples
Read Items on a List
This example demonstrates how to retrieve the metadata of a list with its columns and items. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
Configure the SharePoint Online - List Read Snap as follows to get the list along with its items and columns metadata.
Upon validation, the Snap displays the results in the output preview.