Sharepoint Online - Download File

In this article

Overview

Snap enables you to download the content of the primary stream (file) of a DriveItem. 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“.

Prerequisites

  • Use valid SharePoint Online tenant and associated site in account and snap settings respectively.
  • Valid application in Azure portal with necessary permissions to the application. To learn more, including how to choose permissions, see Permissions.

Support for Ultra Pipelines

See Snap Support for Ultra Pipelines.

Limitations and Known Issues

N/A 

Snap Input and Output


Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A document containing the metadata of the item to be downloaded.


Output

Document

  • Min:0
  • Max:1
  • Mapper Snap
  • Copy Snap
  • CSV Parser
  • JSON Parser
  • ... ...

A binary document containing the downloaded item.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 

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.  This property enables you to define the name of a site, which contains the list of document library to be used in the subsequent settings.

N/A

MySite

Document Library

String

Required. This property enables you to select Drive representing the top-level container for a file system, such as OneDrive or SharePoint document libraries. This field will be populated dynamically from different sites from the suggestion dropdown. Users are allowed either to choose a document library from suggestion dropdown or type an entity manually.

If an expression is used in the Site property, then the document library cannot be suggested. 

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

N/ASettings to influence connection properties to the SharePoint Online APIs.N/AN/A

Connection timeout

intRequired. This property enables you to set the connection timeout duration in seconds.3030

Number of retries

intRequired. This property enables you to set the maximum number of re-connections in case of connection failure or timeout.35

Retry interval (seconds)

intRequired. This property enables you to set the time interval in seconds between connection attempts.1010

Snap Execution

DropDown

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & Execute

N/A

For more information on how to download an item in the SharePoint Online please refer to the graph API, see driveitem-get-content.

Troubleshooting

ErrorReasonResolution
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:403Either 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:404You cannot get content for a folderEnsure the file path have been provided in the source file path

Examples

The example assumes that you have configured & authorized a valid SharePoint Online Account (see SharePoint Online Account).

The following SharePoint Online - Download File snap and pipeline shows how to download a file and store it in the SLDB.


The configuration of the SharePoint Online - Download File snap is shown below. The Snap specifies how to download the content of the item of type file.


A successful validation or execution of the Snap gives the following output preview, showing the results.


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. Furnish Pipeline parameters as applicable.

  File Modified

File SP_1.0.0_DownloadFile_2020_05_29.slp

Jun 04, 2020 by Rojo Publisher

Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'EXPORTSPACE:SharePoint Online Snap Pack'.


See Also