Get Drive Item

In this article


Use this Snap to retrieve the details of a driveItem from a OneDrive or Shared Library (Document Library) location such as parent references, name, webUrl, and size.


  • A valid application in Azure Portal with appropriate permissions.
  • A valid Microsoft OneDrive license.
  • Read access to the folder/file mentioned in the Source Relative Path/ID.

Support for Ultra Pipelines

Works in Ultra Pipelines.



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


  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • Get Drive
  • Get Share Permissions
A document containing the details of the location of a driveItem.


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

A document containing information about the selected driveItem and optionally, its children information.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
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 driveTypes in this drop-down list (to retrieve the driveItem information) and specify the corresponding details needed:

  • OneDrive. To retrieve a driveItem's information from a OneDrive location. Requires UserDrive, and Source Relative Path/ID.
  • documentLibraryTo retrieve a driveItem's information in a shared library (document library)Requires Shared LibraryDrive, and Source Relative Path/ID.
  • DriveTo retrieve a driveItem's information (in user's OneDrive or shared library) using the Drive ID. Requires Drive (ID) and Source Relative Path/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 driveItem's informationRequires User, Drive, and Source Relative Path/ID.

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

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


Required for all Drive Type options.

Specify the name of the drive to retrieve details of a specific driveItem 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 the driveItem details, typically from the upstream Snap.

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

Specify the Source Relative Path/ID of the driveItem, next.

Source Relative Path/IDString/Expression

Required for all Drive Type options.

Enter the relative path for the driveItem to retrieve its details, beginning with root:/. Alternatively, pass the item ID in this field.

  • Any URL in this field that starts with root:/ is treated as relative path. All other entries (without root:/ at the beginning) are treated as driveItem IDs.
  • When the driveItem ID passed is invalid (not a 34-character alphanumeric code such as 014ZXBQNNHW2DJ3CDKQZBJHRYWFWVRRQA2), the Snap returns the error - The resource is not found.
ExpandCheck boxSelect this check box to include all metadata about the children items in the Snap output. If you do not select this check box, the Snap returns the total number children entities under the selected driveItem, along with the parent's metadata.Not selectedSelected
Select FieldsString/Expression

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

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

N/Aid, parentReference
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





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


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


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


Download this Pipeline


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


Snap Pack Version 




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.


Upgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10571

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.
StableNo updates made.





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

See Also