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. 

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. Works in Ultra Pipelines. However, we recommend that you not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper

  • JSON Parser

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



Output

Document

  • Min: 1

  • Max: 1

  • Copy

  • JSON Parser

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:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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

Field Name

Field Type

Description

Label*

 

Default Value: SharePoint Online - Read List
Example: 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
ExampleMySite

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 ValueDeselected

Checkbox

List name

 

Default Value: N/A
ExampleDemolist

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.

Item ID

 

Default Value: N/A
ExampleAAHHTY66773qghd67FF

String/Expression

Specify the unique item ID of the Item to be read. 

Select fields

 

Default Value: N/A
Exampleid, webUrl, lastModifiedBy

String/Expression

Specify the comma-separated field/column names from the metadata to be included to the output view.

Get items

 

Default ValueDeselected

Checkbox

Select to get the items of the specified list along with the list metadata.

The Snap returns a maximum of only 200 records when you select this checkbox.

Get columns

 

Default ValueDeselected

Checkbox

Select to get the column metadata along with the list metadata.

Connection details

Use this field set to specify connection properties to the SharePoint Online APIs. 

Connection Timeout*

 

Default Value30
Example40

Integer

Specify the connection timeout duration in seconds.

Number of Retries*

 

Default Value3
Example5

Integer

Specify the maximum number of reconnections in case of a connection failure or timeout.

Retry Interval (seconds)*

 

Default Value10
Example11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution

 

Default ValueValidate & Execute
ExampleExecute only

Dropdown list

Specify the required Pipeline 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.

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

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.

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