Get Shared Items

In this article

Overview

Use this Snap to retrieve the list of driveItems in your OneDrive or Share Library (Document Library) that are being shared (not expired shares) at a given point in time.

Prerequisites

  • A valid application in Azure Portal with appropriate permissions.
  • A valid Microsoft OneDrive license.
  • Read access to the drive.

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

None.

Known Issues

Snaps in the Microsoft OneDrive Snap Pack have an in-built retry mechanism for failing connections and requests; but, a high volume of requests from a client might reach the throttling threshold. In such scenarios, the Microsoft Graph limits further requests from that client for a period of time and returns an HTTP status code 429 (Too many requests), thereby causing the requests to fail. Hence, we recommend you to keep a check on the number of requests emanating from your client instance.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • Get Drive Item
A document containing the drive/shared library identification to retrieve the list of items being shared.
Output

Document

  • Min: 1
  • Max: 1
  • Mapper
  • Copy
  • Get Share Permissions

A document containing the list of items being shared in the selected drive or Shared Library location.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Specify a 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.
Get Shared ItemsGet Shared Items
Drive TypeDrop-down list

Required. Select a drive using the following list of permitted driveTypes in this drop-down list (to retrieve the list of shared items in the drive) and specify the corresponding details needed:

  • OneDrive. To retrieve the list of shared items in a OneDrive location. Requires User and Drive.
  • documentLibraryTo retrieve the list of shared items in a shared library (document library)Requires Shared Library and Drive.
  • DriveTo retrieve the list of shared items in a drive (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID).
  • All. To select a drive from the list of all drives and shared libraries (including SharePoint sites) that you can access, and retrieve the list of shared items in the driveRequires User and Drive.
OneDrivedocumentLibrary
UserString/Expression/Suggestion

Required for Drive Type options - OneDrive and All. Not needed for Drive and documentLibrary.

Select a user from the suggested list of users to retrieve the list of shared items in that user's OneDrive location.

The list of users displayed varies based on your access to their OneDrive locations. This option is meant for administrator users who are authorized to manage other users' drives, as well.

N/ASnap Team:snap@snaplogic.net
Shared LibraryString/Expression/Suggestion

Required for Drive Type option - documentLibrary. Not needed for OneDrive, Drive, and All.

Select a Shared Library from the suggested list of libraries to retrieve the list of shared items in that library location.

The list of shared libraries displayed varies based on your access to them. This option is meant for users who have write access on both the source and target shared libraries.

N/ANewSharedLibrary
DriveString/Expression/Suggestion

Required for all Drive Type options.

Specify the name of the drive to retrieve the list of shared items in it. The suggestions for this field are based on the Snap account and the User or Shared Library selected.

For the Drive Type Drive, specify/pass the ID of the drive to retrieve its details, typically from the upstream Snap.

For the drive type All, select a drive from the OneDrive or a Shared Library drive.

N/AOneDrive
Select FieldsString/Expression

Enter the list of different parameters, separated by a comma, that you want to retrieve the list of shared items in the selected drive.

The Snap returns all the available information on each retrieved driveItem, if this field is left blank.

N/Aid, email, roles
Number Of RetriesString/ExpressionSpecify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.03
Retry Interval (Seconds)String/ExpressionEnter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached.12
Snap ExecutionDrop-down list

Select one of the three following modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps downstream from it.

Validate & ExecuteExecute only

Troubleshooting

<TBU>

ErrorReasonResolution







Examples

Retrieving the list of Shared Items from your OneDrive/Shared Library

This Pipeline demonstrates how you can get the list of items you have shared with other users. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters. 

We configure the Get Shared Items Snap to get the list of items in one of your Drive (OneDrive or Shared Library), that you shared with your fellow users. You can select the fields you want to display in the results (output of this Snap).

Get Shared Items Snap
Output

For this Snap, we also define an error view to handle error scenarios and merge the error records with the Snap's output using a Union Snap. To filter the fields in the output to suit our needs, we can connect a Mapper Snap and define the fields accordingly.

Mapper Snap

Output

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

Mar 02, 2022 by Subhajit Sengupta

Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 

Stable

Upgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10571
Latest

Updated the error output view of the OneDrive - Upload File Snap from a Binary view to a Document view.

4.25main9554 StableEnhanced the Update Share Permissions Snap with the Share Type and Expires fields that enable you to update the share permissions on your OneDrive items shared using the Invite or Link option. If the Share type is link, you can specify the expiry date and time for the URL that is used to share permissions.
4.24main8556 
StableNo updates made.

4.23

main73

 

Stable

Initial release of the Snap Pack with the following Snaps and Accounts:


See Also