SharePoint Online - Read List
In this article
Overview
You can use this Snap to read metadata of a list from the SharePoint Online site. Also, as an option, it enables you to read a specific entry of the list or get all entries in the list along with its metadata.
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.
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 list to be retrieved. |
Output | Document |
|
| An output document contains the metadata information of a list. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label* | 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. | N/A | SharePoint Online - List Read |
Site* | String | Specify the name of a site that contains the list of document library to be used in the subsequent settings. | N/A | MySite |
Custom Site Path | Check-box | Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has a prefix ‘sites/’ before the sitename, a custom site can contain the prefix ‘teams/’ or it can have no prefix. | Not Selected | Selected |
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 you enable the Site property as an expression, then the document library is not suggested, resulting in an exception. | 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 | Check box | Enable this checkbox to get the items of the specified list along with the list metadata. | Not selected | |
Get Columns | Check box | Optional. Enable this checkbox to get the column metadata along with the list metadata. | ||
Connection details | You can use this field set to influence connection properties to the SharePoint Online APIs. This field set comprises the following fields:
| |||
Connection timeout* | Integer | This property enables you to set the connection timeout duration in seconds. | 30 | 30 |
Number of retries* | Integer | This property enables you to set the maximum number of re-connections in case of connection failure or timeout. | 3 | 2 |
Retry interval (seconds)* | Integer | This property enables you to set the time interval in seconds between connection attempts. | 10 | 10 |
Snap Execution | String | Specifies the execution type:
| Validate & Execute | Execute only |
For more information on how to read a list in the SharePoint Online, refer to the graph API in 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
Reading Items on a List
This example demonstrates how to retrieve the metadata of a list along with its columns and items. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
First, we configure the SharePoint Online - List Read Snap as follows to get the list along with its items and columns metadata.
After successfully validating/executing of the Snap, the results display in the output preview.
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Furnish Pipeline parameters as applicable.
Snap Pack History
See Also
- Configuring SharePoint Online Account
- SharePoint Online - Copy Item
- SharePoint Online - Create Folder
- SharePoint Online - Create Item Permission
- SharePoint Online - Create List
- SharePoint Online - Delete Item
- SharePoint Online - Delete Item Permission
- SharePoint Online - Delete List Item
- SharePoint Online - Document Library
- SharePoint Online - Download File
- SharePoint Online - Get Item
- SharePoint Online - Get Item Permissions
- SharePoint Online - Get Sites
- SharePoint Online - Item Children
- SharePoint Online - List Read Items
- SharePoint Online - Read List
- SharePoint Online - Search Items
- SharePoint Online - Update Item
- SharePoint Online - Update Item Permission
- SharePoint Online - Update List Item
- SharePoint Online - Upload File