SharePoint Online - List Read Items

In this article

Overview

You can use this Snap to read items of a list from the SharePoint Online site. The Snap allows the following operations on the list of items being read:

  • Filter the list items using query parameters

  • Retrieve item details from specific fields (columns) in the list

  • Sort the list items retrieved in the result

Snap Type

SharePoint Online - List Read Items 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 not use this Snap in an Ultra Pipeline. To know the list of Snaps that work in Ultra and the related caveats, refer to 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

  • Copy

A document containing the metadata of the list items to be retrieved.

Output

Document

  • Min: 1

  • Max: 1

  • CSV Parser

  • Join

A document containing the list items in the selected 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 - List Read Items
Example: SharePoint Online - List Read Items

String

Specify a unique 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

Enable this option if your site URL contains a custom path that deviates from the default site URL. Default site path always has the prefix ‘site/’ before the sitename, a custom site can contain the prefix ‘team/’ or it can have no prefix.

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.

Filter query

 

Default Value: N/A
ExamplestartsWith(fields/Title, 'Demo')

String/Expression

Enter the query to filter the retrieved list of items from the selected list when you want to retrieve a set of list items.

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.

Expand list items

 

Default Value: N/A
ExampleTitle

String/Expression

Specify the comma-separated column names of the list to be retrieved from the list.

Top

 

Default Value200
Example100

Integer/Expression

Specify an integer value to define the number of retrieved list items to be displayed per page (pagination).

While providing a value in this field, do not select Auto pagination check box.

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.

While selecting this check box, ensure that the Top field is blank.

Order by Properties

Use this fieldset to Enter the properties and order they want to be displayed when found more one item with one or more similar properties. 

Property name

 

Default Value: N/A
Examplename

String/Expression

Specify the attribute name of the item/drive/folder to be sorted.

Order type

 

Default Valueasc
Exampledesc

Dropdown list/Expression

Select the appropriate order type to perform the sorting at the server-side. Avaialble options are:

  • asc

  • desc

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 items in a list in the SharePoint Online, please refer to the graph API, see list-items-read.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

HTTP Response Code:404

The specified List name was not found.

Ensure that the entered List name is valid and that the Snap has access to it.

Forbidden exception:403

Either the user or the app does not have sufficient permissions to read the metadata for the document library.

Ensure that the required permissions are provided to the account both at the user level and the application level.

HTTP Response Code:400

Response Message: Invalid filter clause

Ensure that the filter condition provided is valid and does not resolve to zero records.

Failure: The fields "Automatic pagination" and "Top" cannot be used at the same time. Please implement only one of them.

The Snap can either perform automatic pagination of all records or retrieve the top n number of records for the result set, but not both simultaneously.

Select/specify only one of these options: Auto pagination check box, Top field.

Examples

Reading Items on a List

This Pipeline example demonstrates how you can retrieve the items of a list along with its metadata of the item. The example assumes that you have configured and authorized a valid SharePoint Online Account. For more information, refer to SharePoint Online Account.

Configure the SharePoint Online - List Read Items Snap as shown below to retrieve the items along with the respective metadata.

After successful validation or execution of the Snap, the results displays 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. Provide Pipeline parameters as applicable.

Snap Pack History