JDBC Driver for Smartsheet

Build 22.0.8462

DownloadAttachment

Download an attachment from a sheet.

Input

Name Type Required Accepts Output Streams Description
SheetID String True False The sheet ID you are downloading an attachment from.
AttachmentID String True False Unique ID of the attachment you are downloading.
Location String False False The folder path in which to save the attachment.
FileName String False False A new name for the downloaded attachment. If not specified, the attachment will be saved as a file with its original name in the sheet.
FileStream String False True An instance of an output stream where file data is written to. Only used if Location is not set.
Override String False False Specifies whether you want to override an existing file in the Location with the same name. Setting it to false will generate a unique name of the file where the content of the attachment will be saved, if a file with the same name already exists.

The default value is true.

Result Set Columns

Name Type Description
Success String Returns True if the download succeeded.
URL String A temporary URL for downloading the file. Currently, the temporary URL is set to expire in 120000 milliseconds, or 2 minutes
Content String Base64 encoded content of the downloaded file, returned if Location and FileStream are not provided.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462