Skip to content

Commit 6c20330

Browse files
committed
Update README
1 parent b349ee0 commit 6c20330

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Gives new Node-RED node types for your automation workflows, which are designed
1818

1919
- [Create Dataset](#create-dataset)
2020
- [Launch and Monitor a Run](#launch-and-monitor-a-run)
21+
- [List Files from Data Explorer](#list-data-link-files)
2122

2223
Also [Launch](#launch) and [Workflow](#workflow) nodes for more custom workflows where polling workflow status is not required and it's helpful to have full control.
2324

@@ -126,6 +127,28 @@ Each message contains:
126127
- `msg._seqera_request`: The request details sent to the API (when error occurs)
127128
- `msg._seqera_error`: Error details (when error occurs)
128129

130+
## List Data Link Files
131+
132+
Lists files and folders from a Seqera Platform **Data Explorer** link.
133+
134+
### Inputs
135+
136+
- **dataLinkName** (string): The Data Explorer link to query.
137+
- **basePath** (string): Path within the data link to start browsing. Leave blank for the root.
138+
- **prefix** (string): Optional prefix filter (applies to files _and_ folders).
139+
- **pattern** (string): Optional regular-expression pattern filter (applies to **files** only).
140+
- **returnType** (string): Choose what to return: `files`, `folders`, or `all` (everything).
141+
- **maxResults** (number): Maximum number of results to return (default: 100).
142+
- **depth** (number): How many directory levels to recurse into (0 = current dir only).
143+
- **workspaceId** (string): Override the workspace ID from the Config node.
144+
145+
### Outputs (one output)
146+
147+
- `msg.payload` (array): Array of objects returned by the API after filtering.
148+
- `msg.files` (array): Convenience array containing only the file names.
149+
- `msg._seqera_request`: Details of the API request (useful for debugging).
150+
- `msg._seqera_error`: Error details if the request fails.
151+
129152
## Launch
130153

131154
Launches a workflow using the Seqera API.

0 commit comments

Comments
 (0)