SharePoint Online - List Read
In this article
Overview
This Snap provides the ability to read metadata of a list from SharePoint Online site. Optionally it also enables one to read a specific entry of the list or get all entries in the list along with its metadata.
Prerequisites
- 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
- Works in Ultra Pipelines.
See Snap Support for Ultra Pipelines.
Limitations and Known Issues
N/A
Snap Input and Output
| Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing the metadata of the list to be retrieved. |
| Output | Document |
|
| A document containing the metadata information of a list. |
Snap Settings
| 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 - List Read |
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 |
List Name | String | Optional. This property enables you to select the name of the list. This field suggest all the list that belong to the SharePoint Online site. If an expression is used in the Site property, then the document library cannot be suggested. | N/A | Demolist |
Item Id | String | Optional. The unique item id of the Item to be read. | N/A | 1 |
Select fields | String | Optional. Enter the comma-separated properties to be written to the output view. | N/A | |
| Get Items | boolean | Enable this checkbox to get the items of the specified list along with the list metadata. | disabled | |
| Get Columns | boolean | Optional. Enable this checkbox to get the column metadata along with the list metadata. | ||
Connection details | N/A | Settings to influence connection properties to the SharePoint Online APIs. | N/A | N/A |
Connection timeout | int | Required. This property enables you to set the connection timeout duration in seconds. | 30 | 30 |
Number of retries | int | Required. This property enables you to set the maximum number of re-connections in case of connection failure or timeout. | 3 | 2 |
Retry interval (seconds) | int | Required. This property enables you to set the time interval in seconds between connection attempts. | 10 | 10 |
Snap Execution | DropDown | Specifies the execution type:
| Validate & Execute | Execute only |
For more information on how to read a list in the SharePoint Online please refer to the graph API, see list-get.
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| HTTP Response Code:404 | Entered item not found in the document library | Please ensure to provide the valid item path to get the metadata. |
| Forbidden exception:403 | Either 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
The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
The following SharePoint Online Read list Item snap and pipeline show how to fetch the metadata of a list along with its columns and items.
The configuration of the SharePoint - Online List Read sanp is shown below. The Snap specifies how to get the list along with its items and columns metadata.
A successful validation or execution of the Snap gives the following output preview, showing the results.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Furnish Pipeline parameters as applicable.
See Also
Have feedback? Email helpdesk@rojoconsultancy.com © Rojo Consultancy