SharePoint Online - Read List

Created by Ankur Parekh
Last updated: Jan 19, 2022 by Kalpana Malladi

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/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser

An input document contains the metadata of the list to be retrieved.


Output

Document

  • Min:1
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser

An output document contains the metadata information of a list.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

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 PathCheck-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 SelectedSelected

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

StringOptional. Enter the comma-separated properties to be written to the output view.N/A
Get ItemsCheck box

Enable this checkbox to get the items of the specified list along with the list metadata.

Not selected
Get ColumnsCheck boxOptional. 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
  • Number of retries
  • Retry interval (seconds)

Connection timeout*

IntegerThis property enables you to set the connection timeout duration in seconds.3030

Number of retries*

IntegerThis property enables you to set the maximum number of re-connections in case of connection failure or timeout.32

Retry interval (seconds)*

IntegerThis property enables you to set the time interval in seconds between connection attempts.1010

Snap Execution

String

Specifies the execution type:

  • Validate & Execute. Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only. Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled. Disables the Snap and, by extension, its downstream Snaps.

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

ErrorReasonResolution
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:403Either 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.

Download this Pipeline.

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Furnish Pipeline parameters as applicable.

  File Modified

File Example_Sharepoint__Read_List.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

4.29main108 StableUpgraded with the latest SnapLogic Platform release.
4.28 Patchesmain101 LatestFixed the Auto Refresh Token issue in the SharePoint Online Account.
4.28main100 StableAdded the SharePoint Online - Get Sites Snap that enables you to get the list of sites specific to the logged-in user from the SharePoint Online site.
4.27main93 StableUpgraded with the latest SnapLogic Platform release.
4.26main89 LatestEnhanced all Snaps in the SharePoint Online Snap Pack to support dynamic site and document library values using input document variables.
4.26main88 StableUpgraded with the latest SnapLogic Platform release.
4.25main75 StableNo updates made.
4.24main75 StableNo updates made.
4.23main74 LatestFixes the error view issue in SharePoint Online - Upload File Snap by dragging a new instance of SharePoint Online - Upload File Snap to the canvas as the existing Snap that was used with a version that contained the bug will continue to fail.
4.23main74 Latest

Fixes the socket timeout issue in the Snap Pack by making the following changes:

  • Modifies the code to return the ProxyHttpClient instead of the basic HTTP client and handle the custom siteName.
  • Fixes the broken JUnit and code for pagination in the SharePoint Online - List Read Items Snap.
4.23main73 LatestIntroduces a new Snap, SharePoint Online - List Read Items Snap, that enables you to read, sort, and filter list items from your SharePoint Online libraries/collections.
4.22 Patchesmain39 StableFixes the Snap document link for SharePoint Online - List Read Items.
4.22-Patches422patches6694 Latest
  • Fixes the List Read Snap NPE(null pointer exception) failure, when the List Name field is empty.
  • Fixes the Search Items Snap issue by providing the same result set when more than one document is passed.
4.22main6403 Stable

No updates made.

4.21-Patches421patches6011 
  • Latest
  • Stable
Introduces the productized version of SharePoint Online Snap Pack, which enables organizations to share and manage content and collaborate across an organization

4.21

snapsmrc535

 

Latest

Beta release of the SharePoint Online Snap Pack

See Also