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.

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
Example: MySite

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 Value: Deselected

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
Example: Demolist

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.

Filter query

Default Value: N/A
Example: startsWith(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
Example: id, 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
Example: Title

String/Expression

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

Top

Default Value: 200
Example: 100

Integer/Expression

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

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.

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
Example: name

String/Expression

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

Order type

Default Value: asc
Example: desc

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 Value: 30
Example: 40

Integer

Specify the connection timeout duration in seconds.

Number of Retries*

Default Value: 3
Example: 5

Integer

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

Retry Interval (seconds)*

Default Value: 10
Example: 11

Integer

Specify the time interval in seconds between connection attempts.

Snap Execution

Default Value: Validate & Execute
Example: Execute 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.

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.