FlowmageDocs

List

Reads data

Lists the files in storage, or only those whose name begins with what you type.

Settings

SettingWhat it is
Name prefixByte-exact and case-sensitive. Lists the environment this run is in, 1,000 files per page.
Include archived filesArchived files are listed but cannot be read — leave this off before a loop.
If more filesReturn the first page with a nextCursor to list a folder of any size in a loop.
CursorContinue a previous list from its nextCursor.
Technical details
KeyValue
prefixtextthe start of file names
includeArchivedtrue/false, by default false
ifMoreFiles"fail" or "first", by default "fail"
cursortext

Output

FieldType
filesarray
countNumber of filesnumber
nextCursorCursor for the next pagestring
Sample output, and the expression for each field
  • count0
  • files[]

Errors

When a step of this node stops a run, the run page shows a code. Look it up:

Example step

The step as a flow file holds it. Replace each value in <…>.

{
  "config": {
    "cursor": "",
    "ifMoreFiles": "fail",
    "includeArchived": false,
    "prefix": ""
  },
  "label": "List",
  "type": "file.list",
  "version": 1
}