activities
latest
false
UiPath logo, featuring letters U and I in white

Workflow Activities

Last updated Dec 20, 2024

DownloadStorageFile

Downloads a copy of a file in an Orchestrator storage bucket locally.

Definition

Namespace: UiPath.Activities.System.API

Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)

Overloads

  
DownloadStorageFile(String, String)Downloads a copy of a file in an Orchestrator storage bucket locally.
DownloadStorageFile(String, String, String)Downloads a copy of a file in an Orchestrator storage bucket locally, at a specified folder path.
DownloadStorageFile(String, String, String, String, Int32)Downloads a copy of a file in an Orchestrator storage bucket locally, at a specified folder path, and with a destination, along with other configurations.

DownloadStorageFile(String, String)

Downloads a copy of a file in an Orchestrator storage bucket locally.

ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName
)ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName
)
path String
The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container.
storageBucketName String
The name of the Storage Bucket the file is located in.

DownloadStorageFile(String, String, String)

Downloads a copy of a file in an Orchestrator storage bucket locally, at a specified folder path.

ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName,
	string folderPath
)ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName,
	string folderPath
)
path String
The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container.
storageBucketName String
The name of the Storage Bucket the file is located in.
folderPath String
The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used.

DownloadStorageFile(String, String, String, Int32)

Downloads a copy of a file in an Orchestrator storage bucket locally, at a specified folder path, and with TimeoutMS configured.

ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName,
	string folderPath,
	string destination,
	int timeoutMS
)ILocalResource DownloadStorageFile(
	string path,
	string storageBucketName,
	string folderPath,
	string destination,
	int timeoutMS
)
path String
The full path of the file from the Storage Bucket you want to download. The file must exist in the source Orchestrator Storage container.
storageBucketName String
The name of the Storage Bucket the file is located in.
folderPath String
The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used.
destination String
The full local path with file name where you want to download the file. Relative paths are resolved based on the runtime execution directory. This path must contain the filename in order for the activity to work.
timeoutMS Int32
Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).

Return value

ILocalResource

Reference to the downloaded file.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.