@@ -115,26 +115,26 @@ curl -X POST "https://your.server.com/iot/logic/flow/create" \
115
115
-H " Content-Type: application/json" \
116
116
-H " Authorization: NVX hash_value" \
117
117
-d ' {
118
- "flow": { # Flow entity creation
118
+ "flow": {
119
119
"title": "Basic Temperature Monitoring",
120
- "enabled": true, # If true, the flow starts to process data immediately after creation
121
- "nodes": [ # Node entity creation right inside new flow
120
+ "enabled": true,
121
+ "nodes": [
122
122
{
123
- "id": 1, # First node creation with an ID unique within a flow
123
+ "id": 1,
124
124
"type": "data_source",
125
125
"enabled": true,
126
- "data": { # Node-specific parameters, depend on node type
126
+ "data": {
127
127
"title": "Fleet Vehicles",
128
- "sources": [394892, 394893, 394894] # Actual data sources from your accountm can be found in Devices and Settings
128
+ "sources": [394892, 394893, 394894]
129
129
},
130
- "view": { # First node postion, defining the display in UI
130
+ "view": {
131
131
"position": {
132
132
"x": 50,
133
133
"y": 100
134
134
}
135
135
}
136
136
},
137
- { # Second node creation
137
+ {
138
138
"id": 2,
139
139
"type": "initiate_attributes",
140
140
"data": {
@@ -148,32 +148,32 @@ curl -X POST "https://your.server.com/iot/logic/flow/create" \
148
148
}
149
149
]
150
150
},
151
- "view": { # Second node postion, defining the display in UI
151
+ "view": {
152
152
"position": {
153
153
"x": 300,
154
154
"y": 100
155
155
}
156
156
}
157
157
},
158
158
{
159
- "id": 3, # third node creation
159
+ "id": 3,
160
160
"type": "output_endpoint",
161
161
"enabled": true,
162
162
"data": {
163
163
"title": "Navixy Platform",
164
164
"output_endpoint_type": "output_navixy"
165
165
},
166
- "view": { # Third node postion, defining the display in UI
166
+ "view": {
167
167
"position": {
168
168
"x": 550,
169
169
"y": 100
170
170
}
171
171
}
172
172
}
173
173
],
174
- "edges": [ # Transitions that connect nodes in a flow
174
+ "edges": [
175
175
{
176
- "from": 1, # Notice, that nodes are referenced by their IDs
176
+ "from": 1,
177
177
"to": 2
178
178
},
179
179
{
@@ -192,6 +192,29 @@ Response (example):
192
192
"id" : 123
193
193
}
194
194
```
195
+
196
+ ### Parameters explained
197
+
198
+ * ** Flow entity** : The main container defining a complete data processing pipeline
199
+ * ` title ` : Names your flow for easier identification
200
+ * ` enabled ` : When true, flow begins processing data immediately after creation
201
+ * ** Nodes** : Functional components that each handle a specific step in data processing
202
+ * ** Node 1 (data_source)** :
203
+ * Entry point collecting data from devices (IDs: 394892, 394893, 394894)
204
+ * Unique ID within the flow for connection references
205
+ * Position coordinates control UI display location
206
+ * ** Node 2 (initiate_attributes)** :
207
+ * Transforms data with custom calculations
208
+ * Creates new "temperature_f" attribute using formula
209
+ * Uses timestamps for data validity tracking
210
+ * ** Node 3 (output_endpoint)** :
211
+ * Destination for processed data
212
+ * Type "output_navixy" sends to Navixy platform
213
+ * Final step in the processing pipeline
214
+ * ** Edges** : Define connections between nodes
215
+ * Reference nodes by their IDs to create the processing sequence
216
+ * Create a clear path for data to follow from source to destination
217
+
195
218
<!-- theme: success -->
196
219
> This single request creates a complete flow that:
197
220
> 1 . Collects data from three specific devices (IDs: 394892, 394893, 394894)
0 commit comments