Workflow Activities

Last updated Dec 20, 2024

ListStorageFiles

Lists files matching a given pattern from a specified Storage Bucket in Orchestrator.

Definition

Namespace: UiPath.Activities.System.API

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

Overloads

Method	Description
`ListStorageFiles(String, String)`	Lists files matching a given pattern from a specified Storage Bucket in Orchestrator.
`ListStorageFiles(String, String, String)`	Lists files matching a given pattern from a specified Storage Bucket in Orchestrator, at a specified folder path.
`ListStorageFiles(String, String, String, Boolean, String, Int32)`	Lists files matching a given pattern from a specified Storage Bucket in Orchestrator, along with other configurations.

`ListStorageFiles(String, String)`

Lists files matching a given pattern from a specified Storage Bucket in Orchestrator.

IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName
)IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName
)

directory String: The directory from where you want to start the matching. This field is mandatory. If this field is left empty, the operation begins in the root directory. Use \ as a directory separator to specify the desired destination directory.
storageBucketName String: The name of the Storage Bucket the file is located in.

`ListStorageFiles(String, String, String)`

Lists files matching a given pattern from a specified Storage Bucket in Orchestrator, at a specified folder path.

IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName,
	string folderPath
)IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName,
	string folderPath
)

directory String: The directory from where you want to start the matching. This field is mandatory. If this field is left empty, the operation begins in the root directory. Use \ as a directory separator to specify the desired destination directory.
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. Use / as a directory separator to specify the desired destination directory.

`ListStorageFiles(String, String, String, Boolean, String, Int32)`

Lists files matching a given pattern from a specified Storage Bucket in Orchestrator, along with other configurations.

IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName,
	string folderPath,
	bool recursive,
	string filter,
	int timeoutMS
)IEnumerable<StorageFileInfo> ListStorageFiles(
	string directory,
	string storageBucketName,
	string folderPath,
	bool recursive,
	string filter,
	int timeoutMS
)

directory String

The directory from where you want to start the matching. This field is mandatory. If this field is left empty, the operation begins in the root directory. Use \ as a directory separator to specify the desired destination directory.

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. Use / as a directory separator to specify the desired destination directory.

recursive Boolean

A boolean variable which specifies whether to recurse through all child directories.

filter String

A matching pattern to filter the result files by. If left empty, all files are returned (starting from Directory, depending on how the Recursive property field is configured). This field is optional. The matching syntax is that of file globbing and, specifically, it matches the rules of the Microsoft FileSystemGlobbing Matcher:

*.pdf - Matches all files with the .pdf extension in the directory.
\*.pdf - Matches all files with the .pdf extension in the directory and any child directory (note that it does not override Recurse setting, if you ask for and specify Recurse False it will only list the Directory folder).

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).