Input 

Document

• Min: 0

• Max: 1

• Mapper

• JSON Parser

An input document that 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.

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

List name

Default Value: N/A
Example: Demolist

String/Expression/Suggestion

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.

Item ID

Default Value: N/A
Example: 7852452664

String/Expression/Suggestion

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

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.

Get items

Default Value: Deselected

Checkbox

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

Get columns

Default Value: Deselected

Checkbox

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

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.

Connection details

Use this field set to configure connection properties for 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

Entered item not found in the document library

Ensure to provide the valid item path to get the metadata.

Forbidden exception:403

Either the 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.