Get Drive Item
- Anand Vedam
- Gouri Bhagchandani
In this article
Overview
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.
Prerequisites
- 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.
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/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing the details of the location of a driveItem. |
| Output | Document |
|
| A document containing information about the selected driveItem and optionally, its children information. |
Snap Settings
| Parameter Name | Data Type | Description | Default Value | Example |
|---|---|---|---|---|
| Label | String | 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 Drive | Get Drive |
| Drive Type | Drop-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 | documentLibrary |
| User | String/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 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. | N/A | Snap Team:snap@snaplogic.net |
| Shared Library | String/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. | N/A | NewSharedLibrary |
| Drive | String/Expression/Suggestion | 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. | N/A | OneDrive |
| Source Relative Path/ID | String/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.
| root:/ | /Pictures/Tour1/ |
| Expand | Check box | Select 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 selected | Selected |
| Select Fields | String/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/A | id, parentReference |
| Number Of Retries | String/Expression | Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout. | 0 | 3 |
| Retry Interval (Seconds) | String/Expression | Enter, in seconds, the duration for which the Snap must wait between two reconnection attempts, until the number of retries is reached. | 1 | 2 |
| Snap Execution | Drop-down list | Select one of the three following modes in which the Snap executes:
| Validate & Execute | Execute only |
Troubleshooting
<TBU>
| Error | Reason | Resolution |
|---|---|---|
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 |
 |
Downloads
Important Steps to Successfully Reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.
Snap Pack History
See Also
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.