Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

  • Use valid SharePoint Online tenant and associated site in account and snap settings respectively.
  • Valid application in Azure portal with necessary permissions to the application. To learn more, including how to choose permissions, see Permissions.

Support for Ultra Pipelines

...

Limitations and Known Issues

N/A 

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

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


Output

Document

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

A document containing the metadata information of a list.

...

Parameter NameData TypeDescriptionDefault ValueExample 

Label

String

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

Required.  This property enables you to define the name of a site, which contains the list of document library to be used in the subsequent settings.

N/A

MySite

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. 

Warning

If an expression is used in the Site property, then the document library cannot be suggested. 


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 Itemsboolean

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

disabled
Get ColumnsbooleanOptional. Enable this checkbox to get the column metadata along with the list metadata.

Connection details

N/ASettings to influence connection properties to the SharePoint Online APIs.N/AN/A

Connection timeout

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

Number of retries

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

Retry interval (seconds)

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

Snap Execution

DropDown

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

...

The example assumes that you have configured & authorized a valid SharePoint Online Account (see Sharepointonline SharePoint Online Account).

The following SharePoint Online Read list Item snap and pipeline show how to fetch the metadata of a list along with its columns and items.

...