In this article
You can use this Snap to download the content of the primary stream (file) of a item. The Snap writes the binary stream to the output view.
Note: Only driveItems with the file property can be downloaded. If the item to be downloaded is of type folder, the Snap will fail with an exception message “You cannot get content for a folder“.
To know the list of Snaps that work in Ultra and the related caveats, see Snap Support for Ultra Pipelines.
None.
Input/Output | Type of View | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| An input document contains the metadata of the item to be downloaded. |
Output | Document |
|
| An output binary document contains the downloaded item. |
Parameter Name | Data Type | Description | Default Value | Example | |
---|---|---|---|---|---|
Label | String | Required. The 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. | N/A | SharePoint Online - Download File | |
Site | String | Required. The name of a site that contains the list of document library to be used in the subsequent Snap settings. | N/A | MySite | |
Custom Site Path | Check-box | Not Selected | Selected | ||
Document Library | String | Required. This property enables you to select a drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field populates dynamically from different sites via the suggestion drop-down. You can either choose a document library from suggestion drop-down list or enter the entity name manually.
| N/A | Shared Documents | |
Source item relative path | String | Required. The driveItem resource path that represents a file stored in a document library/folder | N/A | testFile.pdf | |
Connection details | Settings to influence connection properties to the SharePoint Online APIs. This fieldset comprises the following fields:
| ||||
Connection timeout | Integer | Required. Enables you to set the connection timeout duration in seconds. | 30 | 30 | |
Number of retries | Integer | Required. Enables you to set the maximum number of reconnections in case of connection failure or timeout. | 3 | 5 | |
Retry interval (seconds) | Integer | Required. Enables you to set the time interval in seconds between connection attempts. | 10 | 10 | |
Snap Execution | String | Specify the required Pipeline execution type:
| Validate & Execute | Validate & Execute |
For more information on how to download an item in the SharePoint Online, refer to the graph API in driveItem-get-content.
Error | Reason | Resolution |
---|---|---|
HTTP Response Code:404 | Entered item not found in the document library | Please ensure to provide the valid item path to get the metadata. |
Forbidden exception:403 | Either user or app doesn't have sufficient permissions to read the metadata for the document library. | Ensure to provide the desired permissions both at the user and application level. |
HTTP Response Code:404 | You cannot get content for a folder | Ensure the file path have been provided in the source file path |
This example demonstrates how to download a file and store it in the SnapLogic data base. The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).
The following screenshot displays the settings of the SharePoint Online - Download File. The Snap specifies on how to download the content of the item of type file.
After successfully validating/executing the above Snap, the results display in the following output preview.
|