Input 

Document

• Min: 0

• Max: 1

• Mapper Snap

• Copy Snap

An input document contains the metadata of the item to be retrieved, such as, site, item name, etc.

Output

Document

• Min: 1

• Max: 1

• CSV Parser

• JSON Parser

An output document contains the metadata information of an item.

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 when 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 - Get Item
Example: SharePoint Online - Get Item

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

Document Library*

Default Value: N/A
Example: Shared Documents

String/Expression

Specify the a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion drop-down list. You can either choose a document library from suggestion drop-down list or enter the entity name manually.

Source item relative path*

Default Value: N/A
Example: testFile.pdf

String/Expression

Specify the item resource path that represents a file, folder, or other item stored in a document library.

Select fields

Default Value: N/A
Example: id, email, roles

String/Expression

Enter the comma-separated properties to be written to the output view.

Expand

Default Value: Deselected

Checkbox

Select to fetch children items of the folder. This is an optional field which should only be enabled if the Source item relative path property is selected. In case the value of the field Source item relative path is set to file, then this property setting will be ignored.

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

Entered item not found in the document library

Please ensure to provide the valid item path to get the metadata.

Forbidden exception:403

The user or the 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.