ListSFTPFile

Description

Lists all blob files under a virtual directory using specified sorting and name pattern options.

info

• Ensure that you have a properly configured SFTP connection resource set up under the Resources folder.
• SFTP file names are typically case-sensitive; therefore, abc.JPG, abc.jpg, and ABC.jpg will be saved as different files. To ensure consistency, we recommend using lower-case file names and extensions: abc.jpg.

Configuration

Field	Required	Description	Example
Name	Required	The name of the activity. This name must be unique in a workflow.	List Deployment Error Files
Description	Optional	The description of the activity. We recommend you make this as clear as possible to guide execution, foster understanding, and support collaboration.	Lists application error files created in the deployment-errors folder post deployment.
ABS Connection	Required	A predefined resource for accessing ABS blobs.	/Resources/ABSConnection
Container Name	Required	The name of the container in ABS.	hrms-deployment
Blob Path	Required	The location of the virtual directory that contains the blobs that you want to list. Note While entering the path, only include the virtual directories without adding the container name, because the container name is already specified (see Container Name, above).	For example, consider the following complete path: hrms-deployment/deployment-errors/application In this complete path: hrms-deployment is the blob container. application is the virtual directory that contains the error files that you want listed. deployment-errors/application is the path to the blob.
Pattern	Optional	The file pattern that you want to use to filter the list of files in the target virtual directory.	*.txt
Prefix	Optional	Lists blobs whose names begin with the specified prefix.	2025-03-31
Max Results	Optional	Specifies the maximum number of search results to return at a time.	10
Recursive	Optional	Instructs the application to retrieve matching blobs recursively from child folders.	Deselected
Descending	Optional	Instructs the application to display results in alphabetically descending order.	Deselected

Input

Field	Required	Data Type	Description	Example
filepath	Optional	String	The location of the virtual directory (without the container name) that contains the blobs that you want to list.	image-processing/temp
pattern	Optional	String	The file pattern that you want to use to filter the list of files in the target virtual directory.	*.txt
prefix	Optional	String	The prefix that you want to use to identify blobs to be listed from the specified file path.	EMP_2025_
maxResult	Optional	Number	The maximum number of search results that you want to be returned at a time.	20
recursive	Optional	Boolean	Instructs the application to retrieve matching blobs recursively from child folders, if true.	FALSE
descending	Optional	Boolean	Instructs the application to display results in alphabetically descending order, if true.	FALSE

Output

Field	Required	Data Type	Description	Example
schema	Required	NA	A custom schema that can be imported.	NA
title	Required	String	Title of the object containing the data returned.	ListFileOutput
path	Required	String	The path to the object, without the container name.	image-processing/temp
files	Required	Array	The list of files returned as a result of the List query.	NA
files > path	Required	String	The path, without the container name, of the file.	image-processing/temp
files > name	Required	String	Name of the file	EMP_2025_00123.png
files > size	Required	Number	The size of the file (in bytes).	2500
files > createdTime	Required	String	The date-time when the file was created.	2025-03-10T19:20:30+01:00
files > lastModified	Required	String	The date-time when the file was last modified.	2025-03-15T09:10:30+01:00
files > permissions	Required	String	Permissions associated with the file.	Read, write, delete or manage blobs
files > properties	Required	String	Properties associated with the file.	blob_type
files > directory	Required	Boolean	Indicates a child directory.	True
totalFiles	Required	Number	Indicates the number of files in the target directory.	23