Versions Compared

Old Version 3

changes.mady.by.user Anand Vedam

Saved on

compared with

New Version 4

changes.mady.by.user Anand Vedam

Saved on

Key

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

In this article

Table of Contents
maxLevel2
absoluteUrltrue

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.

Image Added

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
Insert excerpt
File Writer
File Writer
nopaneltrue
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, Drive, and Source Relative Path/ID.
  • documentLibrary. To retrieve the list of shared items in a shared library (document library). Requires Shared Library, Drive, and Source Relative Path/ID.
  • Drive. To 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 drive. Requires User, Drive, and Source Relative Path/ID.
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.

Info

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.

Info

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.

Info

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

Image Added

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. 

Image Added

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
Image Added
Output

Image Added

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

Image Added

Output

Image Added

Download this Pipeline.

Downloads

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

Attachments
patterns*.slp, *.zip

Insert excerpt
Microsoft OneDrive Snap Pack
Microsoft OneDrive Snap Pack
nopaneltrue

...

See Also