Service: Flow

This API is not yet officially released nor maintained.

Service to store and control Blickfeld flows.

It is used to implement the custom storage API: https://nodered.org/docs/api/storage/

Table 1. Available methods
Method	Request	Response
Get	FlowGetRequest	FlowGetResponse
List	google.protobuf.Empty	FlowListResponse
Store	FlowStoreRequest	google.protobuf.Empty
Delete	FlowDeleteRequest	google.protobuf.Empty
Watch	FlowWatchRequest	FlowWatchResponseStream
StoreGlobalNodes	FlowStoreGlobalNodesRequest	google.protobuf.Empty
GetGlobalNodes	google.protobuf.Empty	FlowGetGlobalNodesResponse
WatchGlobalNodes	google.protobuf.Empty	FlowWatchGlobalNodesResponse
Reload	google.protobuf.Empty	google.protobuf.Empty

Get

Get a flow by id

Request

Flow get request

Table 2. Available fields in blickfeld.flow.services.FlowGetRequest
Field	Type	Default	Unit
id	string	-	-
id	Flow id
as_node_red_json	bool	-	-
as_node_red_json	If true, the request returns the NodeRed JSON format which can be directly imported.

Response

Flow get response

Table 3. Available fields in blickfeld.flow.services.FlowGetResponse
Field	Type	Default	Unit
flow	config.Flow	-	-
flow	Blickfeld Flow config with well-defined high-level attributes
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format which can be directly imported

List

Return list of flow ids

Response

Flow list response

Table 4. Available fields in blickfeld.flow.services.FlowListResponse
Field	Type	Default	Unit
ids	repeated string	-	-
ids	List of Blickfeld Flow identifiers.

Store

Store flow

A "Reload" is required to apply the operation.

Request

Flow store request

Table 5. Available fields in blickfeld.flow.services.FlowStoreRequest
Field	Type	Default	Unit
id	string	-	-
id	ID of the flow NOTE: For node_red_json, this has to match the ID in the NodeRED JSON format.
flow	config.Flow	-	-
flow	Blickfeld Flow config with well-defined high-level attributes
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format which can be directly exported from NodeRED Admin UI

Delete

Delete stored flow

A "Reload" is required to apply the operation.

Request

Flow delete request

Table 6. Available fields in blickfeld.flow.services.FlowDeleteRequest
Field	Type	Default	Unit
id	string	-	-
id	Id of Blickfeld Flow

Watch

Watch flow changes

Request

Flow watch request

Table 7. Available fields in blickfeld.flow.services.FlowWatchRequest
Field	Type	Default	Unit
as_node_red_json	bool	-	-
as_node_red_json	If true, the request returns the NodeRed JSON format which can be directly imported.

Response Stream

Per change, a response is emitted

Table 8. Available fields in blickfeld.flow.services.FlowWatchResponse
Field	Type	Default	Unit
id	string	-	-
id	Id of Blickfeld Flow
flow	config.Flow	-	-
flow	Blickfeld Flow config with well-defined high-level attributes
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format which can be directly exported from NodeRED Admin UI
type	config.data.WatchEvent.Type	-	-
type	Type of change

StoreGlobalNodes

Store global nodes

A "Reload" is required to apply the operation.

Request

Flow store global nodes request

Table 9. Available fields in blickfeld.flow.services.FlowStoreGlobalNodesRequest
Field	Type	Default	Unit
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format of all global configuration nodes

GetGlobalNodes

Get global nodes

Response

Flow get global nodes response

Table 10. Available fields in blickfeld.flow.services.FlowGetGlobalNodesResponse
Field	Type	Default	Unit
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format of all global configuration nodes

WatchGlobalNodes

Watch global nodes

Response

Flow watch global nodes response

Table 11. Available fields in blickfeld.flow.services.FlowWatchGlobalNodesResponse
Field	Type	Default	Unit
node_red_json	config.NodeRedJson	-	-
node_red_json	NodeRed JSON format of all global configuration nodes

Reload

Reload node-red

This reloads all nodes from the config and restart all nodes.