Skip to content

Get Files – listing stored files

The command "Get Files" writes the list of files stored under an identifier into a variable. This page is for administrators who need the ID, name or size of stored files in an action – to download, read, mail or delete them.

1. At a glance
Purpose List the files filed under an identifier
Typical use Find the file to download, attach, read or delete; check whether a document exists
Where in the editor Toolbar menu "Files" → "Get Files"
Needs a user interface No
Needs a current record Yes
Related Add File, Download File, Get File Data, Remove File

2. Settings

The settings are on the tab "Settings". "Display Name", "Description" and "Execution Condition" are on the tab "General" (see Actions).

Setting Meaning Default / Required
"File Provider" The kind of storage: "Azure Blob Storage" or "S3 Storage" Required
"Credentials" The credentials of the storage, of the kind that matches the file provider Required
"Identifier" Expression for the identifier the files were stored under – the same value as in Add File or in the files form block Required
"Result Variable" The variable the list is written into Required

3. Behaviour

  1. Without a current record, or without "File Provider" or "Credentials", the command is skipped.
  2. The command reads the files with this identifier from the storage. Files that the current record has queued but not saved yet are included; files it has marked for deletion are left out.
  3. The list is written into "Result Variable" as a JSON array. An empty identifier finds nothing.
  4. If the storage cannot be read, the reason is written to the log and the variable keeps its previous value.

Files are found by the identifier alone, not by record. Two records that use the same identifier see the same files.

The list

Each element of the array describes one file:

Property Content
Id The ID of the file – the value for "File Id" in the other file commands
FileName The file name
MimeType The content type
FileSize The size in bytes
BlockIdentifier The identifier the file is filed under
TimestampCreated, TimestampLastModified When the file was stored and last changed

Example:

[
  {
    "Id": "6f1c2b7e-3d0a-4c55-9a51-2e8c1b0f9d42",
    "FileName": "contract.pdf",
    "MimeType": "application/pdf",
    "FileSize": 182344,
    "BlockIdentifier": "contract-1043",
    "TimestampCreated": "2026-09-14T08:12:31Z",
    "TimestampLastModified": "2026-09-14T08:12:31Z"
  }
]

4. Examples

Check whether a signed contract exists. "Get Files" with the identifier signed-contract- followed by the record ID writes into SignedContract. A Modify Value expression with the rule JArrayHasElements on SignedContract gives true or false – for example as condition of a switch.

Process every file. Iterate JSON over the variable runs its commands once per file; the current element is a JSON object from which Id and FileName can be read.

5. Limitations

  • The command cannot run without a current record.
  • The list can only be filtered by identifier. Filter by name or type with value modification rules or with conditions inside a loop.