SharePoint Online - Get Item

In this article

Overview

You can use this Snap to get the metadata of an item (files/folders) from the SharePoint Online document library. In cases where the item is a folder, it is also possible to retrieve the children item (which can be other folders or files).

Snap Type

SharePoint Online - Get Item 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.

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

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 ValueSharePoint Online - Get Item
ExampleSharePoint 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
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

Document Library*

 

Default Value: N/A
ExampleShared 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.

If you enable the Site property as an expression, then the document library is not suggested, resulting in an exception.



Source item relative path*

 

Default Value: N/A
ExampletestFile.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
Exampleid, email, roles

String/Expression

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

Expand

 

Default ValueDeselected

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 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 retrieve details of an item in the SharePoint, refer to the graph API Get-Item.

Troubleshooting

Error

Reason

Resolution

Error

Reason

Resolution

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.

Examples

Retrieving Item Metadata

This example demonstrates how you can move the metadata details of a particular item are retrieved from the document library. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

 

The following screenshot displays the settings of the SharePoint Online - Get Item Snap. The Snap specifies to get the metadata of a folder. It also retrieves the children of the folder.

After successfully validating/executing the above Snap, the results display in the following 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.

  File Modified

File Example_Sharepoint_Getitem.slp

Mar 11, 2022 by Subhajit Sengupta

Snap Pack History