ultravisor 1.0.21 → 1.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/_version.json +7 -0
- package/docs/css/docuserve.css +277 -23
- package/docs/features/beacon-authentication.md +24 -31
- package/docs/features/beacon-providers.md +31 -37
- package/docs/features/beacons.md +20 -19
- package/docs/features/case-study-retold-remote.md +28 -28
- package/docs/features/llm-model-setup.md +15 -15
- package/docs/features/llm.md +29 -27
- package/docs/features/platform-cards.md +10 -10
- package/docs/features/reachability-matrix.md +12 -12
- package/docs/features/tasks-content-system.md +32 -32
- package/docs/features/tasks-data-transform.md +64 -64
- package/docs/features/tasks-extension.md +14 -14
- package/docs/features/tasks-file-system.md +94 -94
- package/docs/features/tasks-flow-control.md +38 -38
- package/docs/features/tasks-http-client.md +40 -40
- package/docs/features/tasks-llm.md +58 -58
- package/docs/features/tasks-meadow-api.md +50 -50
- package/docs/features/tasks-user-interaction.md +12 -12
- package/docs/features/tasks.md +20 -20
- package/docs/features/universal-addressing.md +12 -12
- package/docs/index.html +2 -2
- package/docs/retold-catalog.json +30 -1
- package/docs/retold-keyword-index.json +15389 -12741
- package/package.json +4 -3
- package/source/services/Ultravisor-Beacon-Coordinator.cjs +39 -0
- package/source/services/Ultravisor-ExecutionEngine.cjs +15 -2
- package/source/services/Ultravisor-OperationAuditor.cjs +471 -0
- package/source/web_server/Ultravisor-API-Server.cjs +54 -0
- package/test/Ultravisor_tests.js +132 -0
|
@@ -10,20 +10,20 @@ Reads a file from the local file system into operation state.
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **FilePath**
|
|
14
|
-
- **Encoding**
|
|
15
|
-
- **MaxBytes**
|
|
13
|
+
- **FilePath** -- Path to the file to read. Supports Pict template expressions for dynamic paths.
|
|
14
|
+
- **Encoding** -- Character encoding (default `utf8`). Use `binary` for non-text files.
|
|
15
|
+
- **MaxBytes** -- Maximum bytes to read. Set to `0` for unlimited.
|
|
16
16
|
|
|
17
17
|
### Outputs
|
|
18
18
|
|
|
19
|
-
- **FileContent**
|
|
20
|
-
- **BytesRead**
|
|
21
|
-
- **FileName**
|
|
19
|
+
- **FileContent** -- The full text content of the file.
|
|
20
|
+
- **BytesRead** -- Number of bytes that were read.
|
|
21
|
+
- **FileName** -- The base name of the file (no directory).
|
|
22
22
|
|
|
23
23
|
### Events
|
|
24
24
|
|
|
25
|
-
- **ReadComplete**
|
|
26
|
-
- **Error**
|
|
25
|
+
- **ReadComplete** -- Fires after a successful read.
|
|
26
|
+
- **Error** -- Fires if the file cannot be found or read.
|
|
27
27
|
|
|
28
28
|
### Tips
|
|
29
29
|
|
|
@@ -37,25 +37,25 @@ Reads a file in chunks up to a maximum buffer size, splitting on a preferred cha
|
|
|
37
37
|
|
|
38
38
|
### Settings
|
|
39
39
|
|
|
40
|
-
- **FilePath**
|
|
41
|
-
- **Encoding**
|
|
42
|
-
- **MaxBufferSize**
|
|
43
|
-
- **SplitCharacter**
|
|
44
|
-
- **ByteOffset**
|
|
40
|
+
- **FilePath** -- Path to the file to read.
|
|
41
|
+
- **Encoding** -- Character encoding (default `utf8`).
|
|
42
|
+
- **MaxBufferSize** -- Maximum bytes per chunk (default `65536`).
|
|
43
|
+
- **SplitCharacter** -- Preferred character to split on (default newline). The chunk is trimmed to the last occurrence of this character within the buffer so records are not broken mid-line.
|
|
44
|
+
- **ByteOffset** -- Byte offset to start reading from. Use `0` for the first chunk and feed the output ByteOffset back for continuation.
|
|
45
45
|
|
|
46
46
|
### Outputs
|
|
47
47
|
|
|
48
|
-
- **FileContent**
|
|
49
|
-
- **BytesRead**
|
|
50
|
-
- **ByteOffset**
|
|
51
|
-
- **IsComplete**
|
|
52
|
-
- **FileName**
|
|
53
|
-
- **TotalFileSize**
|
|
48
|
+
- **FileContent** -- Content of the current chunk.
|
|
49
|
+
- **BytesRead** -- Bytes in this chunk.
|
|
50
|
+
- **ByteOffset** -- Updated byte offset for the next read.
|
|
51
|
+
- **IsComplete** -- `true` when the entire file has been read.
|
|
52
|
+
- **FileName** -- Base name of the file.
|
|
53
|
+
- **TotalFileSize** -- Total size of the file in bytes.
|
|
54
54
|
|
|
55
55
|
### Events
|
|
56
56
|
|
|
57
|
-
- **ReadComplete**
|
|
58
|
-
- **Error**
|
|
57
|
+
- **ReadComplete** -- Fires when a chunk is read successfully.
|
|
58
|
+
- **Error** -- Fires on read failure.
|
|
59
59
|
|
|
60
60
|
### Tips
|
|
61
61
|
|
|
@@ -69,17 +69,17 @@ Reads a JSON file from disk, parses it, and stores the resulting object in opera
|
|
|
69
69
|
|
|
70
70
|
### Settings
|
|
71
71
|
|
|
72
|
-
- **FilePath**
|
|
73
|
-
- **Destination**
|
|
72
|
+
- **FilePath** -- Path to the JSON file.
|
|
73
|
+
- **Destination** -- State address to store the parsed data. If empty, data is stored at the default output address.
|
|
74
74
|
|
|
75
75
|
### Outputs
|
|
76
76
|
|
|
77
|
-
- **Data**
|
|
77
|
+
- **Data** -- The parsed JSON object or array.
|
|
78
78
|
|
|
79
79
|
### Events
|
|
80
80
|
|
|
81
|
-
- **Complete**
|
|
82
|
-
- **Error**
|
|
81
|
+
- **Complete** -- Fires after successful read and parse.
|
|
82
|
+
- **Error** -- Fires if the file is missing or contains invalid JSON.
|
|
83
83
|
|
|
84
84
|
### Tips
|
|
85
85
|
|
|
@@ -93,23 +93,23 @@ Writes text content to a file on disk.
|
|
|
93
93
|
|
|
94
94
|
### Settings
|
|
95
95
|
|
|
96
|
-
- **FilePath**
|
|
97
|
-
- **Content**
|
|
98
|
-
- **Encoding**
|
|
99
|
-
- **Append**
|
|
100
|
-
- **LineEnding**
|
|
96
|
+
- **FilePath** -- Path to the output file. Intermediate directories are created automatically.
|
|
97
|
+
- **Content** -- The text content to write. Supports Pict template expressions.
|
|
98
|
+
- **Encoding** -- Character encoding (default `utf8`).
|
|
99
|
+
- **Append** -- When `true`, appends to an existing file instead of overwriting it.
|
|
100
|
+
- **LineEnding** -- Force a line ending style: `lf`, `crlf`, or leave empty for no conversion.
|
|
101
101
|
|
|
102
102
|
### Outputs
|
|
103
103
|
|
|
104
|
-
- **FileLocation**
|
|
105
|
-
- **FileName**
|
|
106
|
-
- **FilePath**
|
|
107
|
-
- **BytesWritten**
|
|
104
|
+
- **FileLocation** -- The path as specified (may be relative).
|
|
105
|
+
- **FileName** -- The base file name only.
|
|
106
|
+
- **FilePath** -- The fully resolved absolute path.
|
|
107
|
+
- **BytesWritten** -- Number of bytes written.
|
|
108
108
|
|
|
109
109
|
### Events
|
|
110
110
|
|
|
111
|
-
- **WriteComplete**
|
|
112
|
-
- **Error**
|
|
111
|
+
- **WriteComplete** -- Fires on success.
|
|
112
|
+
- **Error** -- Fires on write failure.
|
|
113
113
|
|
|
114
114
|
### Tips
|
|
115
115
|
|
|
@@ -123,24 +123,24 @@ Serializes a state object to JSON and writes it to a file on disk.
|
|
|
123
123
|
|
|
124
124
|
### Settings
|
|
125
125
|
|
|
126
|
-
- **FilePath**
|
|
127
|
-
- **DataAddress**
|
|
128
|
-
- **PrettyFormat**
|
|
129
|
-
- **IndentType**
|
|
130
|
-
- **IndentCount**
|
|
131
|
-
- **SortKeys**
|
|
126
|
+
- **FilePath** -- Path to the output JSON file.
|
|
127
|
+
- **DataAddress** -- State address of the data to serialize. If empty, uses the full operation state.
|
|
128
|
+
- **PrettyFormat** -- Pretty-print with indentation (default `true`).
|
|
129
|
+
- **IndentType** -- Indent character: `tab` or `space` (default `tab`).
|
|
130
|
+
- **IndentCount** -- Number of indent characters per level (default `1`).
|
|
131
|
+
- **SortKeys** -- Alphabetically sort object keys for deterministic output.
|
|
132
132
|
|
|
133
133
|
### Outputs
|
|
134
134
|
|
|
135
|
-
- **FileLocation**
|
|
136
|
-
- **FileName**
|
|
137
|
-
- **FilePath**
|
|
138
|
-
- **BytesWritten**
|
|
135
|
+
- **FileLocation** -- The path as specified.
|
|
136
|
+
- **FileName** -- The base file name only.
|
|
137
|
+
- **FilePath** -- The fully resolved absolute path.
|
|
138
|
+
- **BytesWritten** -- Number of bytes written.
|
|
139
139
|
|
|
140
140
|
### Events
|
|
141
141
|
|
|
142
|
-
- **Done**
|
|
143
|
-
- **Error**
|
|
142
|
+
- **Done** -- Fires on success.
|
|
143
|
+
- **Error** -- Fires on write failure.
|
|
144
144
|
|
|
145
145
|
### Tips
|
|
146
146
|
|
|
@@ -154,21 +154,21 @@ Copies a file from a source path to a target path.
|
|
|
154
154
|
|
|
155
155
|
### Settings
|
|
156
156
|
|
|
157
|
-
- **Source**
|
|
158
|
-
- **TargetFile**
|
|
159
|
-
- **Overwrite**
|
|
157
|
+
- **Source** -- Source file path.
|
|
158
|
+
- **TargetFile** -- Destination file path.
|
|
159
|
+
- **Overwrite** -- Allow overwriting an existing target file (default `true`).
|
|
160
160
|
|
|
161
161
|
### Outputs
|
|
162
162
|
|
|
163
|
-
- **FileLocation**
|
|
164
|
-
- **FileName**
|
|
165
|
-
- **FilePath**
|
|
166
|
-
- **BytesCopied**
|
|
163
|
+
- **FileLocation** -- The target path as specified.
|
|
164
|
+
- **FileName** -- The target file name only.
|
|
165
|
+
- **FilePath** -- The fully resolved absolute target path.
|
|
166
|
+
- **BytesCopied** -- Size of the copied file in bytes.
|
|
167
167
|
|
|
168
168
|
### Events
|
|
169
169
|
|
|
170
|
-
- **Done**
|
|
171
|
-
- **Error**
|
|
170
|
+
- **Done** -- Fires on successful copy.
|
|
171
|
+
- **Error** -- Fires if the source is missing or the target cannot be written.
|
|
172
172
|
|
|
173
173
|
### Tips
|
|
174
174
|
|
|
@@ -182,21 +182,21 @@ Lists files in a directory with optional glob pattern filtering.
|
|
|
182
182
|
|
|
183
183
|
### Settings
|
|
184
184
|
|
|
185
|
-
- **Folder**
|
|
186
|
-
- **Pattern**
|
|
187
|
-
- **Destination**
|
|
188
|
-
- **Recursive**
|
|
189
|
-
- **IncludeDirectories**
|
|
185
|
+
- **Folder** -- Directory path to list.
|
|
186
|
+
- **Pattern** -- Glob pattern filter (e.g. `*.txt`, `*.json`). Default `*` matches all files.
|
|
187
|
+
- **Destination** -- State address to store the resulting file list.
|
|
188
|
+
- **Recursive** -- When `true`, includes files in subdirectories.
|
|
189
|
+
- **IncludeDirectories** -- When `true`, includes directory entries in the results.
|
|
190
190
|
|
|
191
191
|
### Outputs
|
|
192
192
|
|
|
193
|
-
- **Files**
|
|
194
|
-
- **FileCount**
|
|
193
|
+
- **Files** -- Array of file name strings matching the pattern.
|
|
194
|
+
- **FileCount** -- Number of entries found.
|
|
195
195
|
|
|
196
196
|
### Events
|
|
197
197
|
|
|
198
|
-
- **Complete**
|
|
199
|
-
- **Error**
|
|
198
|
+
- **Complete** -- Fires after listing is complete.
|
|
199
|
+
- **Error** -- Fires if the directory cannot be read.
|
|
200
200
|
|
|
201
201
|
### Tips
|
|
202
202
|
|
|
@@ -210,19 +210,19 @@ Downloads a file from a URL to the local staging directory.
|
|
|
210
210
|
|
|
211
211
|
### Settings
|
|
212
212
|
|
|
213
|
-
- **SourceURL**
|
|
214
|
-
- **Filename**
|
|
213
|
+
- **SourceURL** -- URL to download the file from (required). Supports Pict template expressions.
|
|
214
|
+
- **Filename** -- Name for the downloaded file in the staging directory (required).
|
|
215
215
|
|
|
216
216
|
### Outputs
|
|
217
217
|
|
|
218
|
-
- **LocalPath**
|
|
219
|
-
- **BytesTransferred**
|
|
220
|
-
- **DurationMs**
|
|
218
|
+
- **LocalPath** -- The fully resolved path to the downloaded file.
|
|
219
|
+
- **BytesTransferred** -- Number of bytes downloaded.
|
|
220
|
+
- **DurationMs** -- Time taken for the download in milliseconds.
|
|
221
221
|
|
|
222
222
|
### Events
|
|
223
223
|
|
|
224
|
-
- **Complete**
|
|
225
|
-
- **Error**
|
|
224
|
+
- **Complete** -- Fires after a successful download.
|
|
225
|
+
- **Error** -- Fires if the download fails or the URL is unreachable.
|
|
226
226
|
|
|
227
227
|
### Tips
|
|
228
228
|
|
|
@@ -236,19 +236,19 @@ Marks a staging file as the operation's binary output. The file is uploaded to t
|
|
|
236
236
|
|
|
237
237
|
### Settings
|
|
238
238
|
|
|
239
|
-
- **FilePath**
|
|
240
|
-
- **OutputKey**
|
|
239
|
+
- **FilePath** -- Path to the file in the staging directory (required).
|
|
240
|
+
- **OutputKey** -- Optional key to identify the output when an operation produces multiple result files.
|
|
241
241
|
|
|
242
242
|
### Outputs
|
|
243
243
|
|
|
244
|
-
- **StagingFilePath**
|
|
245
|
-
- **BytesSent**
|
|
246
|
-
- **DurationMs**
|
|
244
|
+
- **StagingFilePath** -- The resolved path of the file that was sent.
|
|
245
|
+
- **BytesSent** -- Number of bytes uploaded.
|
|
246
|
+
- **DurationMs** -- Time taken for the upload in milliseconds.
|
|
247
247
|
|
|
248
248
|
### Events
|
|
249
249
|
|
|
250
|
-
- **Complete**
|
|
251
|
-
- **Error**
|
|
250
|
+
- **Complete** -- Fires after the file is successfully uploaded.
|
|
251
|
+
- **Error** -- Fires if the file cannot be read or the upload fails.
|
|
252
252
|
|
|
253
253
|
### Tips
|
|
254
254
|
|
|
@@ -262,19 +262,19 @@ Encodes a staging file to a base64 string.
|
|
|
262
262
|
|
|
263
263
|
### Settings
|
|
264
264
|
|
|
265
|
-
- **FilePath**
|
|
266
|
-
- **Destination**
|
|
265
|
+
- **FilePath** -- Path to the file to encode (required).
|
|
266
|
+
- **Destination** -- State address to store the encoded string. If empty, uses the default output address.
|
|
267
267
|
|
|
268
268
|
### Outputs
|
|
269
269
|
|
|
270
|
-
- **EncodedData**
|
|
271
|
-
- **EncodedLength**
|
|
272
|
-
- **OriginalBytes**
|
|
270
|
+
- **EncodedData** -- The base64-encoded string.
|
|
271
|
+
- **EncodedLength** -- Length of the encoded string in characters.
|
|
272
|
+
- **OriginalBytes** -- Size of the original file in bytes.
|
|
273
273
|
|
|
274
274
|
### Events
|
|
275
275
|
|
|
276
|
-
- **Complete**
|
|
277
|
-
- **Error**
|
|
276
|
+
- **Complete** -- Fires after successful encoding.
|
|
277
|
+
- **Error** -- Fires if the file cannot be read.
|
|
278
278
|
|
|
279
279
|
### Tips
|
|
280
280
|
|
|
@@ -288,18 +288,18 @@ Decodes a base64 string and writes the result to a file in the staging directory
|
|
|
288
288
|
|
|
289
289
|
### Settings
|
|
290
290
|
|
|
291
|
-
- **Source**
|
|
292
|
-
- **FilePath**
|
|
291
|
+
- **Source** -- The base64-encoded string to decode (required). Supports Pict template expressions to pull from operation state.
|
|
292
|
+
- **FilePath** -- Path for the output file in the staging directory (required).
|
|
293
293
|
|
|
294
294
|
### Outputs
|
|
295
295
|
|
|
296
|
-
- **LocalPath**
|
|
297
|
-
- **DecodedBytes**
|
|
296
|
+
- **LocalPath** -- The fully resolved path to the decoded file.
|
|
297
|
+
- **DecodedBytes** -- Number of bytes written to the file.
|
|
298
298
|
|
|
299
299
|
### Events
|
|
300
300
|
|
|
301
|
-
- **Complete**
|
|
302
|
-
- **Error**
|
|
301
|
+
- **Complete** -- Fires after successful decoding and write.
|
|
302
|
+
- **Error** -- Fires if the input is not valid base64 or the file cannot be written.
|
|
303
303
|
|
|
304
304
|
### Tips
|
|
305
305
|
|
|
@@ -10,19 +10,19 @@ Evaluates a condition and branches execution to the True or False output. This i
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **DataAddress**
|
|
14
|
-
- **CompareValue**
|
|
15
|
-
- **Operator**
|
|
16
|
-
- **Expression**
|
|
13
|
+
- **DataAddress** -- State address of the value to test.
|
|
14
|
+
- **CompareValue** -- Value to compare against.
|
|
15
|
+
- **Operator** -- Comparison operator: `==`, `!=`, `>`, `<`, `>=`, `<=`, `contains`, `startsWith`, `endsWith`. Default `==`.
|
|
16
|
+
- **Expression** -- A full expression string. When set, DataAddress/CompareValue/Operator are ignored and the expression is evaluated directly.
|
|
17
17
|
|
|
18
18
|
### Outputs
|
|
19
19
|
|
|
20
|
-
- **Result**
|
|
20
|
+
- **Result** -- Boolean result of the evaluation.
|
|
21
21
|
|
|
22
22
|
### Events
|
|
23
23
|
|
|
24
|
-
- **True**
|
|
25
|
-
- **False**
|
|
24
|
+
- **True** -- Fires when the condition is true.
|
|
25
|
+
- **False** -- Fires when the condition is false.
|
|
26
26
|
|
|
27
27
|
### Tips
|
|
28
28
|
|
|
@@ -36,23 +36,23 @@ Splits a string by a delimiter and processes each token through a sub-graph, act
|
|
|
36
36
|
|
|
37
37
|
### Settings
|
|
38
38
|
|
|
39
|
-
- **InputString**
|
|
40
|
-
- **SplitDelimiter**
|
|
41
|
-
- **SkipEmpty**
|
|
42
|
-
- **TrimTokens**
|
|
39
|
+
- **InputString** -- The string to split. Supports Pict template expressions.
|
|
40
|
+
- **SplitDelimiter** -- Delimiter to split on (default newline `\n`).
|
|
41
|
+
- **SkipEmpty** -- When `true`, skips empty tokens after splitting.
|
|
42
|
+
- **TrimTokens** -- When `true`, trims whitespace from each token.
|
|
43
43
|
|
|
44
44
|
### Outputs
|
|
45
45
|
|
|
46
|
-
- **CurrentToken**
|
|
47
|
-
- **TokenIndex**
|
|
48
|
-
- **TokenCount**
|
|
49
|
-
- **CompletedCount**
|
|
46
|
+
- **CurrentToken** -- The current token being processed.
|
|
47
|
+
- **TokenIndex** -- Zero-based index of the current token.
|
|
48
|
+
- **TokenCount** -- Total number of tokens.
|
|
49
|
+
- **CompletedCount** -- Number of tokens processed so far.
|
|
50
50
|
|
|
51
51
|
### Events
|
|
52
52
|
|
|
53
|
-
- **TokenDataSent**
|
|
54
|
-
- **CompletedAllSubtasks**
|
|
55
|
-
- **Error**
|
|
53
|
+
- **TokenDataSent** -- Fires for each token, sending it through the sub-graph.
|
|
54
|
+
- **CompletedAllSubtasks** -- Fires after all tokens have been processed.
|
|
55
|
+
- **Error** -- Fires on failure.
|
|
56
56
|
|
|
57
57
|
### How It Works
|
|
58
58
|
|
|
@@ -74,21 +74,21 @@ Executes a child operation by its hash, with isolated operation state. This enab
|
|
|
74
74
|
|
|
75
75
|
### Settings
|
|
76
76
|
|
|
77
|
-
- **OperationHash**
|
|
78
|
-
- **InputData**
|
|
79
|
-
- **TimeoutMs**
|
|
80
|
-
- **InheritGlobalState**
|
|
77
|
+
- **OperationHash** -- The hash identifier of the operation to launch.
|
|
78
|
+
- **InputData** -- JSON data to pass as input to the child operation.
|
|
79
|
+
- **TimeoutMs** -- Maximum execution time in milliseconds. Set to `0` for unlimited.
|
|
80
|
+
- **InheritGlobalState** -- When `true` (default), copies the parent's GlobalState into the child operation.
|
|
81
81
|
|
|
82
82
|
### Outputs
|
|
83
83
|
|
|
84
|
-
- **Result**
|
|
85
|
-
- **Status**
|
|
86
|
-
- **ElapsedMs**
|
|
84
|
+
- **Result** -- The result data returned by the child operation.
|
|
85
|
+
- **Status** -- Final status of the child operation.
|
|
86
|
+
- **ElapsedMs** -- Execution time of the child operation in milliseconds.
|
|
87
87
|
|
|
88
88
|
### Events
|
|
89
89
|
|
|
90
|
-
- **Completed**
|
|
91
|
-
- **Error**
|
|
90
|
+
- **Completed** -- Fires when the child operation finishes.
|
|
91
|
+
- **Error** -- Fires if the child operation fails or times out.
|
|
92
92
|
|
|
93
93
|
### Tips
|
|
94
94
|
|
|
@@ -102,23 +102,23 @@ Executes a shell command on the server and captures its output.
|
|
|
102
102
|
|
|
103
103
|
### Settings
|
|
104
104
|
|
|
105
|
-
- **Command**
|
|
106
|
-
- **Parameters**
|
|
107
|
-
- **Description**
|
|
108
|
-
- **WorkingDirectory**
|
|
109
|
-
- **TimeoutMs**
|
|
110
|
-
- **Environment**
|
|
105
|
+
- **Command** -- The shell command to execute (e.g. `ls`, `git`, `python3`).
|
|
106
|
+
- **Parameters** -- Command-line arguments as a single string.
|
|
107
|
+
- **Description** -- Human-readable description of what this command does (for documentation only).
|
|
108
|
+
- **WorkingDirectory** -- Working directory for the command.
|
|
109
|
+
- **TimeoutMs** -- Command timeout in milliseconds (default `300000` -- 5 minutes).
|
|
110
|
+
- **Environment** -- JSON object of environment variables to set for the command.
|
|
111
111
|
|
|
112
112
|
### Outputs
|
|
113
113
|
|
|
114
|
-
- **StdOut**
|
|
115
|
-
- **StdErr**
|
|
116
|
-
- **ExitCode**
|
|
114
|
+
- **StdOut** -- Standard output from the command.
|
|
115
|
+
- **StdErr** -- Standard error output from the command.
|
|
116
|
+
- **ExitCode** -- Exit code (0 typically indicates success).
|
|
117
117
|
|
|
118
118
|
### Events
|
|
119
119
|
|
|
120
|
-
- **Complete**
|
|
121
|
-
- **Error**
|
|
120
|
+
- **Complete** -- Fires when the command finishes.
|
|
121
|
+
- **Error** -- Fires if the command fails to start or times out.
|
|
122
122
|
|
|
123
123
|
### Tips
|
|
124
124
|
|
|
@@ -10,20 +10,20 @@ Performs an HTTP GET request and parses the response body as JSON.
|
|
|
10
10
|
|
|
11
11
|
### Settings
|
|
12
12
|
|
|
13
|
-
- **URL**
|
|
14
|
-
- **Headers**
|
|
15
|
-
- **Destination**
|
|
16
|
-
- **TimeoutMs**
|
|
13
|
+
- **URL** -- The URL to request. Supports Pict template expressions for dynamic URLs.
|
|
14
|
+
- **Headers** -- JSON string of additional request headers (e.g. `{"Authorization": "Bearer ..."}`).
|
|
15
|
+
- **Destination** -- State address to store the parsed response data.
|
|
16
|
+
- **TimeoutMs** -- Request timeout in milliseconds (default `30000`).
|
|
17
17
|
|
|
18
18
|
### Outputs
|
|
19
19
|
|
|
20
|
-
- **Data**
|
|
21
|
-
- **StatusCode**
|
|
20
|
+
- **Data** -- The parsed JSON response object.
|
|
21
|
+
- **StatusCode** -- HTTP response status code.
|
|
22
22
|
|
|
23
23
|
### Events
|
|
24
24
|
|
|
25
|
-
- **Complete**
|
|
26
|
-
- **Error**
|
|
25
|
+
- **Complete** -- Fires on a successful response.
|
|
26
|
+
- **Error** -- Fires on network failure, timeout, or non-2xx status.
|
|
27
27
|
|
|
28
28
|
### Tips
|
|
29
29
|
|
|
@@ -37,20 +37,20 @@ Performs an HTTP GET request and returns the response body as plain text.
|
|
|
37
37
|
|
|
38
38
|
### Settings
|
|
39
39
|
|
|
40
|
-
- **URL**
|
|
41
|
-
- **Destination**
|
|
42
|
-
- **Headers**
|
|
43
|
-
- **TimeoutMs**
|
|
40
|
+
- **URL** -- The URL to request.
|
|
41
|
+
- **Destination** -- State address to store the response text.
|
|
42
|
+
- **Headers** -- JSON string of additional request headers.
|
|
43
|
+
- **TimeoutMs** -- Request timeout in milliseconds (default `30000`).
|
|
44
44
|
|
|
45
45
|
### Outputs
|
|
46
46
|
|
|
47
|
-
- **Data**
|
|
48
|
-
- **StatusCode**
|
|
47
|
+
- **Data** -- The response body as a string.
|
|
48
|
+
- **StatusCode** -- HTTP response status code.
|
|
49
49
|
|
|
50
50
|
### Events
|
|
51
51
|
|
|
52
|
-
- **Complete**
|
|
53
|
-
- **Error**
|
|
52
|
+
- **Complete** -- Fires on a successful response.
|
|
53
|
+
- **Error** -- Fires on network failure or timeout.
|
|
54
54
|
|
|
55
55
|
### Tips
|
|
56
56
|
|
|
@@ -64,22 +64,22 @@ Sends JSON data to a URL via HTTP POST or PUT.
|
|
|
64
64
|
|
|
65
65
|
### Settings
|
|
66
66
|
|
|
67
|
-
- **URL**
|
|
68
|
-
- **Method**
|
|
69
|
-
- **DataAddress**
|
|
70
|
-
- **Headers**
|
|
71
|
-
- **Destination**
|
|
72
|
-
- **TimeoutMs**
|
|
67
|
+
- **URL** -- The URL to send data to.
|
|
68
|
+
- **Method** -- HTTP method: `POST` or `PUT` (default `POST`).
|
|
69
|
+
- **DataAddress** -- State address of the object to send as the request body.
|
|
70
|
+
- **Headers** -- JSON string of additional request headers.
|
|
71
|
+
- **Destination** -- State address to store the response data.
|
|
72
|
+
- **TimeoutMs** -- Request timeout in milliseconds (default `30000`).
|
|
73
73
|
|
|
74
74
|
### Outputs
|
|
75
75
|
|
|
76
|
-
- **Response**
|
|
77
|
-
- **StatusCode**
|
|
76
|
+
- **Response** -- The parsed response data.
|
|
77
|
+
- **StatusCode** -- HTTP response status code.
|
|
78
78
|
|
|
79
79
|
### Events
|
|
80
80
|
|
|
81
|
-
- **Complete**
|
|
82
|
-
- **Error**
|
|
81
|
+
- **Complete** -- Fires on success.
|
|
82
|
+
- **Error** -- Fires on failure.
|
|
83
83
|
|
|
84
84
|
### Tips
|
|
85
85
|
|
|
@@ -93,26 +93,26 @@ Performs a fully configurable HTTP request with support for any method, custom c
|
|
|
93
93
|
|
|
94
94
|
### Settings
|
|
95
95
|
|
|
96
|
-
- **URL**
|
|
97
|
-
- **Method**
|
|
98
|
-
- **ContentType**
|
|
99
|
-
- **Headers**
|
|
100
|
-
- **Body**
|
|
101
|
-
- **Destination**
|
|
102
|
-
- **Retries**
|
|
103
|
-
- **TimeoutMs**
|
|
104
|
-
- **RetryDelayMs**
|
|
96
|
+
- **URL** -- The URL to request.
|
|
97
|
+
- **Method** -- HTTP method: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, etc. (default `GET`).
|
|
98
|
+
- **ContentType** -- Content-Type header value (default `application/json`).
|
|
99
|
+
- **Headers** -- JSON string of additional request headers.
|
|
100
|
+
- **Body** -- Request body as a JSON string or raw text.
|
|
101
|
+
- **Destination** -- State address to store the response.
|
|
102
|
+
- **Retries** -- Number of retries on failure (default `0`).
|
|
103
|
+
- **TimeoutMs** -- Request timeout in milliseconds (default `30000`).
|
|
104
|
+
- **RetryDelayMs** -- Delay between retry attempts in milliseconds (default `1000`).
|
|
105
105
|
|
|
106
106
|
### Outputs
|
|
107
107
|
|
|
108
|
-
- **Response**
|
|
109
|
-
- **StatusCode**
|
|
110
|
-
- **ResponseHeaders**
|
|
108
|
+
- **Response** -- The response data.
|
|
109
|
+
- **StatusCode** -- HTTP response status code.
|
|
110
|
+
- **ResponseHeaders** -- JSON string of response headers.
|
|
111
111
|
|
|
112
112
|
### Events
|
|
113
113
|
|
|
114
|
-
- **Complete**
|
|
115
|
-
- **Error**
|
|
114
|
+
- **Complete** -- Fires on success.
|
|
115
|
+
- **Error** -- Fires on failure after all retries are exhausted.
|
|
116
116
|
|
|
117
117
|
### Tips
|
|
118
118
|
|