Get Drive

In this article

Overview

Use this Snap to retrieve the details of a drive in a OneDrive or Shared Library (Document Library) location.

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 Share Permissions
  • Update Share Permissions
A document containing the details of the drive (OneDrive or Shared Library location) to retrieve its information.
Output

Document

  • Min: 1
  • Max: 1
  • Get Drive Item
  • Copy Item
  • Mapper
  • Copy
  • Update Share Permissions

A document containing the drive information for the selected drive.

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 DriveGet Drive
Drive TypeDrop-down list

Required. Select a drive type using the following list of permitted drive types in the drop-down list (to retrieve the drive information) and specify the corresponding details needed:

  • OneDrive. To retrieve the drive information from a OneDrive location. Requires UserDrive, and Source Relative Path/ID.
  • documentLibraryTo retrieve the drive information in a shared library (document library)Requires Shared LibraryDrive, and Source Relative Path/ID.
  • DriveTo retrieve the drive information 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 drive informationRequires 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 details of a drive from 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.
  • Configure the Users.Read.All scope in the Token endpoint parameter value field of the OneDrive User Account to allow this Snap to suggest users in the suggestions.
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 details of a drive from 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

Specify the name of the drive to retrieve its details. 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. If you do not select a drive in this field, the Snap returns information of all the drives that match the settings defined prior to this field.

N/AOneDrive
Select FieldsString/Expression

Enter the list of different parameters, separated by a comma, that you want to retrieve details about the selected drive.

The Snap returns all the available information on the selected 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

ErrorReasonResolution
Unable to fetch users in Suggestions.The scope users.Read.All is not specified in your User account.

Add Users.Read.All scope in the Token endpoint parameter value field of the OneDrive User account.

Examples

Working with Drives and Drive Items using this Snap Pack

This Pipeline demonstrates how you can retrieve information about drives, driveItems and a recursive list of children items under a given driveItem. It assumes that you have configured your Azure application and the Snap accounts already. The Pipeline uses the following parameters. 

We start with the Get Drive Snap to collect information about a particular drive followed by a Get Drive Item Snap to get the details of one of these driveItems. 

Get Drive Snap

Output

We pass the Drive ID to this Snap to gather the relative path/ID of the driveItem we want to view the details of.

Get Drive Item

Snap

We, then, use a Mapper Snap to capture the Drive ID of these driveItems and pass it to the Get Children Snap to retrieve the recursive list of all children items under the relative path/ID provided.

Get Children 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_Drive_Drive_Items_Get_Children.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