Skip to content

Brick object

available_Brick

Represents a single installed brick

Items:

Name Type Doc Constraints
id string id of the brick type [not null]
name string name of the brick type [not null]
family string The general type of brick family (e.g. Inlet) [not null]
description string short description of the brick types function
parameters list of parameter a list of all parameters
portsDescription portdescription short description of the ports [not null]
inputPorts list of port
ouputPorts list of port
lastModified int32 timeStamp of last modification
brickimage string base64 string converted from .svg image

port

A port

Items:

Name Type Doc Constraints
schema string file UJOschema port description
name string port name
typeName string port type name in schema
binarySchema list of binary binary representation of schema
JSONSchema list of NestedTypeDefinition JSON representation of schema

NestedTypeDefinition

type definitions for ujoschema

Items:

Name Type Doc Constraints
name string type name
type list of string type identifier (list for limited variants)
key_value_types list of string types of key and value for maps [key, value] [length( 2 )]
list_type string type of a list
optional bool flag for optional object elements
doc string documentation of the type
constraints list of constraint type limitations
elements list of BaseTypeDefinition elements of objects/records without elements item

BaseTypeDefinition

base type definitions for an ujoschema type

Items:

Name Type Doc Constraints
name string type name
type list of string type identifier (list for limited variants)
key_value_types list of string types of key and value for maps [key, value] [length( 2 )]
list_type string type of a list
optional bool flag for optional object elements
doc string documentation of the type
constraints list of constraint type limitations

constraint

type limitations

Items:

Name Type Doc Constraints
length variant length constraint, e.g. (.. 12)
in list of variant in constraint
not string not null (with default) and not in constraints

parameter

A parameter which can be changed via the UI to modify the behavior of the brick. It can represent any given atomic datatype, buts its value is being converted to a string.

Items:

Name Type Doc Constraints
key string parameter key [not null]
value string parameter value
type string data type of the parameter
editor string indicator for the UI to show a popup dialog instead
constraints constraints UI validation for parameter value

constraints

constraints can be used in UI to validate the value.

Items:

Name Type Doc Constraints
required bool it is true when parameter value is required need
validation string Regular Expression for validating the parameter value
options list of string Possible options for the parameter value

portdescription

descriptive information on ports

Items:

Name Type Doc Constraints
schemaFile string name of the ujs file (default=ports.ujs)
input map of (string, string) input port names : type names
output map of (string, string) output port names : type names