DLI ISO32 Object Model Reference
20210317T210828Z
MQTT client object
objectmqtt/
Object representing the MQTT client configuration
dot_inline_dotgraph_556.png

Retrieving the value is denied if not administrative user

This object contains the following items:

enabledEnabled
outletsOutlet MQTT configuration settings
broker_addressMQTT broker address
broker_portMQTT broker port, if any
use_sslUse SSL
usernameUsername
passwordPassword
topic_rootTopic root
connect_topicConnection message topic
connect_payloadConnection message payload
connect_qosConnection message QoS
connect_retainConnection message retain flag
reconnect_topicReconnection message topic
reconnect_payloadReconnection message payload
reconnect_qosReconnection message QoS
reconnect_retainReconnection message retain flag
disconnect_topicDisconnection message topic
disconnect_payloadDisconnection message payload
disconnect_qosDisconnection message QoS
disconnect_retainDisconnection message retain flag
lwt_topicLast Will and Testament topic
lwt_payloadLast Will and Testament payload
lwt_qosLast Will and Testament QoS
lwt_retainLast Will and Testament retain flag
notificationsNotifications

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/"

...

Sample JS request read command:

request.get({url:"mqtt/"},function(error,response,body) {console.log(body)});

<...>

Browse more samples

Enabled

sum (boolean)mqtt/enabled/
MQTT client enable status
dot_inline_dotgraph_557.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample CLI write command:

uom set "mqtt/enabled" "false"

Sample JS request read command:

request.get({url:"mqtt/enabled/"},function(error,response,body) {console.log(body)});

false

Browse more samples

Outlet MQTT configuration settings

arraymqtt/outlets/
Properties related to exposing outlets via MQTT
dot_inline_dotgraph_558.png

The value is subject to the following constraints: length of the value is equal to length of outlets

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This array represents a value in persistent storage.

This array contains Outlet MQTT configuration elements.

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/mqtt/outlets/',auth=auth,headers=headers).json())

Sample curl outlet MQTT configuration creation command:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"allow_read\":false,\"topic_subtree\":\"t/Ye/6Ij\",\"qos\":2,\"allow_write\":true}" "http://192.168.0.100/restapi/mqtt/outlets/"

Browse more samples

See also Outlet MQTT configuration settings: Outlet MQTT configuration

Outlet MQTT configuration settings: Outlet MQTT configuration

objectmqtt/outlets/N/
Properties related to exposing the outlet via MQTT
dot_inline_dotgraph_559.png

The value is subject to the following constraints: outlets[index of the value]

This object contains the following items:

topic_subtreeTopic subtree, if any
allow_readAllow read
allow_writeAllow write
qosState subscription and report QoS

Sample requests write command (note that _outlet_mqtt_configuration_index is a variable):

requests.put('http://192.168.0.100/restapi/mqtt/outlets/'+str(_outlet_mqtt_configuration_index)+'/',auth=auth,headers=headers,json={'allow_read': False, 'topic_subtree': 'gCFf', 'qos': 2, 'allow_write': False})

Sample JS request write command (note that _outlet_mqtt_configuration_index is a variable):

request.put({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/",body:{"allow_read":true,"topic_subtree":"LFSK","qos":1,"allow_write":true}});

Browse more samples

Topic subtree, if any

sum (optional string)mqtt/outlets/N/topic_subtree/
MQTT topic subtree (relative to the topic root), if any
dot_inline_dotgraph_560.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullOutlet index-basedUse 'outlets/'+the 0-based outlet index as topic subtree
stringTopic subtreeMQTT topic subtree (relative to the topic root)

Sample curl read command (note that :outlet_mqtt_configuration_index is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/outlets/:outlet_mqtt_configuration_index/topic_subtree/"

"/QPWZP"

Sample uom library read command (note that _outlet_mqtt_configuration_index is a variable):

print(uom.dump(uom.mqtt.outlets[_outlet_mqtt_configuration_index].topic_subtree))

"Be9xqXDA"

Browse more samples

Allow read

sum (boolean)mqtt/outlets/N/allow_read/
Outlet state is broadcasted via MQTT
dot_inline_dotgraph_561.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample uom library read command (note that _outlet_mqtt_configuration_index is a variable):

print(uom.dump(uom.mqtt.outlets[_outlet_mqtt_configuration_index].allow_read))

true

Sample requests write command (note that _outlet_mqtt_configuration_index is a variable):

requests.put('http://192.168.0.100/restapi/mqtt/outlets/'+str(_outlet_mqtt_configuration_index)+'/allow_read/',auth=auth,headers=headers,json=True)

Browse more samples

Allow write

sum (boolean)mqtt/outlets/N/allow_write/
Outlet state can be changed via MQTT
dot_inline_dotgraph_562.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample curl write command (note that :outlet_mqtt_configuration_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "true" "http://192.168.0.100/restapi/mqtt/outlets/:outlet_mqtt_configuration_index/allow_write/"

Sample JS request write command (note that _outlet_mqtt_configuration_index is a variable):

request.put({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/allow_write/",body:true});

Browse more samples

State subscription and report QoS

sum (enumerated number)mqtt/outlets/N/qos/
Quality of service when subscribing to and broadcasting outlet state
dot_inline_dotgraph_563.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant 0At most onceMessage should be delivered at most once
constant 1At least onceMessage should be delivered at least once
constant 2Exactly onceMessage should be delivered exactly once

Sample CLI read command (note that outlet_mqtt_configuration_index is a variable):

uom get "mqtt/outlets/${outlet_mqtt_configuration_index}/qos"

0

Sample JS request read command (note that _outlet_mqtt_configuration_index is a variable):

request.get({url:"mqtt/outlets/"+_outlet_mqtt_configuration_index.toString()+"/qos/"},function(error,response,body) {console.log(body)});

0

Browse more samples

MQTT broker address

sum (string)mqtt/broker_address/
Host name or IPv4 address of the MQTT broker to connect to
dot_inline_dotgraph_564.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

stringHostnameHostnamethe value matches ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]).)*([A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z]([A-Za-z0-9-]*[A-Za-z0-9])?)$
stringIPv4 addressIPv4 address in dotted quad notationthe value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Sample requests write command:

requests.put('http://192.168.0.100/restapi/mqtt/broker_address/',auth=auth,headers=headers,json='cwA75v7.BqFZq.JzwL.example.com')

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"zn8HvrwQG.ZEggVA4r.4gIiCAYCbi.example.com\"" "http://192.168.0.100/restapi/mqtt/broker_address/"

Browse more samples

MQTT broker port, if any

sum (optional number)mqtt/broker_port/
Port of the MQTT broker to connect to, if any
dot_inline_dotgraph_565.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant nullUse default portConnect to port 1883 when SSL is not used, port 8883 if SSL is used
numberMQTT broker portPort of the MQTT broker to connect to

all of the following is true:

Sample uom library write command:

uom.mqtt.broker_port="805"

Sample CLI read command:

uom get "mqtt/broker_port"

null

Browse more samples

Use SSL

sum (boolean)mqtt/use_ssl/
Use SSL when connecting to the MQTT broker
dot_inline_dotgraph_566.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueEnabledThe feature is enabled
constant falseDisabledThe feature is disabled

Sample requests write command:

requests.put('http://192.168.0.100/restapi/mqtt/use_ssl/',auth=auth,headers=headers,json=True)

Sample uom library read command:

print(uom.dump(uom.mqtt.use_ssl))

false

Browse more samples

Username

stringmqtt/username/
Username to use when connecting to the MQTT broker
dot_inline_dotgraph_567.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample CLI write command:

uom set "mqtt/username" "\"userwJ8Z\""

Sample JS request write command:

request.put({url:"mqtt/username/",body:"userpTsdu"});

Browse more samples

Password

stringmqtt/password/
Password to use when connecting to the MQTT broker
dot_inline_dotgraph_568.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

This string should be displayed in a secure manner.

Sample JS request write command:

request.put({url:"mqtt/password/",body:"%u%bY#4l"});

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/password/"

"XoEvNRuaOy"

Browse more samples

Topic root

stringmqtt/topic_root/
Topic root to use for all messages
dot_inline_dotgraph_569.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"12oOQiw\"" "http://192.168.0.100/restapi/mqtt/topic_root/"

Sample JS request read command:

request.get({url:"mqtt/topic_root/"},function(error,response,body) {console.log(body)});

"P5Wkx"

Browse more samples

Connection message topic

stringmqtt/connect_topic/
Topic of the message to send on initial connection to broker (not relative to the topic root)
dot_inline_dotgraph_570.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample JS request write command:

request.put({url:"mqtt/connect_topic/",body:"JOR7SlE"});

Sample JS request read command:

request.get({url:"mqtt/connect_topic/"},function(error,response,body) {console.log(body)});

"9sIEsYxj"

Browse more samples

Connection message payload

stringmqtt/connect_payload/
Payload of the message to send on initial connection to broker
dot_inline_dotgraph_571.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample JS request write command:

request.put({url:"mqtt/connect_payload/",body:"Q08r7u"});

Sample CLI read command:

uom get "mqtt/connect_payload"

"r"

Browse more samples

Connection message QoS

sum (enumerated number)mqtt/connect_qos/
Quality of service for the message to send on initial connection to broker
dot_inline_dotgraph_572.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant 0At most onceMessage should be delivered at most once
constant 1At least onceMessage should be delivered at least once
constant 2Exactly onceMessage should be delivered exactly once

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "1" "http://192.168.0.100/restapi/mqtt/connect_qos/"

Sample CLI read command:

uom get "mqtt/connect_qos"

0

Browse more samples

Connection message retain flag

sum (boolean)mqtt/connect_retain/
Flag indicating whether the message to be sent on initial connection to broker should be retained
dot_inline_dotgraph_573.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueRetainedThe latest message payload should be retained on the broker and sent on subscription
constant falseNot retainedMessages should not be retained on the broker

Sample JS request write command:

request.put({url:"mqtt/connect_retain/",body:true});

Sample CLI read command:

uom get "mqtt/connect_retain"

false

Browse more samples

Reconnection message topic

stringmqtt/reconnect_topic/
Topic of the message to send on reconnection to broker (not relative to the topic root)
dot_inline_dotgraph_574.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample CLI read command:

uom get "mqtt/reconnect_topic"

"Te9Ba"

Sample uom library write command:

uom.mqtt.reconnect_topic="zYnGejHXL"

Browse more samples

Reconnection message payload

stringmqtt/reconnect_payload/
Payload of the message to send on reconnection to broker
dot_inline_dotgraph_575.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample uom library write command:

uom.mqtt.reconnect_payload="urH"

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"KGHiqM\"" "http://192.168.0.100/restapi/mqtt/reconnect_payload/"

Browse more samples

Reconnection message QoS

sum (enumerated number)mqtt/reconnect_qos/
Quality of service for the message to send on reconnection to broker
dot_inline_dotgraph_576.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant 0At most onceMessage should be delivered at most once
constant 1At least onceMessage should be delivered at least once
constant 2Exactly onceMessage should be delivered exactly once

Sample uom library read command:

print(uom.dump(uom.mqtt.reconnect_qos))

2

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "0" "http://192.168.0.100/restapi/mqtt/reconnect_qos/"

Browse more samples

Reconnection message retain flag

sum (boolean)mqtt/reconnect_retain/
Flag indicating whether the message to be sent on reconnection to broker should be retained
dot_inline_dotgraph_577.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueRetainedThe latest message payload should be retained on the broker and sent on subscription
constant falseNot retainedMessages should not be retained on the broker

Sample requests write command:

requests.put('http://192.168.0.100/restapi/mqtt/reconnect_retain/',auth=auth,headers=headers,json=False)

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/reconnect_retain/"

false

Browse more samples

Disconnection message topic

stringmqtt/disconnect_topic/
Topic of the message to send before disconnecting from broker (not relative to the topic root)
dot_inline_dotgraph_578.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample uom library write command:

uom.mqtt.disconnect_topic="rIbqAGchgV"

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"Bn8TicG\"" "http://192.168.0.100/restapi/mqtt/disconnect_topic/"

Browse more samples

Disconnection message payload

stringmqtt/disconnect_payload/
Payload of the message to send before disconnecting from broker
dot_inline_dotgraph_579.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample requests write command:

requests.put('http://192.168.0.100/restapi/mqtt/disconnect_payload/',auth=auth,headers=headers,json='')

Sample CLI read command:

uom get "mqtt/disconnect_payload"

"1b"

Browse more samples

Disconnection message QoS

sum (enumerated number)mqtt/disconnect_qos/
Quality of service for the message to send before disconnecting from broker
dot_inline_dotgraph_580.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant 0At most onceMessage should be delivered at most once
constant 1At least onceMessage should be delivered at least once
constant 2Exactly onceMessage should be delivered exactly once

Sample JS request write command:

request.put({url:"mqtt/disconnect_qos/",body:1});

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "0" "http://192.168.0.100/restapi/mqtt/disconnect_qos/"

Browse more samples

Disconnection message retain flag

sum (boolean)mqtt/disconnect_retain/
Flag indicating whether the message to be sent before disconnecting from broker should be retained
dot_inline_dotgraph_581.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueRetainedThe latest message payload should be retained on the broker and sent on subscription
constant falseNot retainedMessages should not be retained on the broker

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/mqtt/disconnect_retain/',auth=auth,headers=headers).json())

True

Sample JS request write command:

request.put({url:"mqtt/disconnect_retain/",body:true});

Browse more samples

Last Will and Testament topic

stringmqtt/lwt_topic/
Topic of the message for the broker to send if the unit goes offline unexpectedly (not relative to the topic root)
dot_inline_dotgraph_582.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"3IBmu\"" "http://192.168.0.100/restapi/mqtt/lwt_topic/"

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/mqtt/lwt_topic/',auth=auth,headers=headers).json())

'Jp9njzCV'

Browse more samples

Last Will and Testament payload

stringmqtt/lwt_payload/
Payload of the message for the broker to send if the unit goes offline unexpectedly
dot_inline_dotgraph_583.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This string represents a value in persistent storage.

Sample uom library read command:

print(uom.dump(uom.mqtt.lwt_payload))

""

Sample uom library write command:

uom.mqtt.lwt_payload="ep"

Browse more samples

Last Will and Testament QoS

sum (enumerated number)mqtt/lwt_qos/
Quality of service for the message for the broker to send if the unit goes offline unexpectedly
dot_inline_dotgraph_584.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant 0At most onceMessage should be delivered at most once
constant 1At least onceMessage should be delivered at least once
constant 2Exactly onceMessage should be delivered exactly once

Sample curl write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "2" "http://192.168.0.100/restapi/mqtt/lwt_qos/"

Sample CLI read command:

uom get "mqtt/lwt_qos"

1

Browse more samples

Last Will and Testament retain flag

sum (boolean)mqtt/lwt_retain/
Flag indicating whether the message to be sent if the unit goes offline unexpectedly should be retained
dot_inline_dotgraph_585.png

Retrieving the value is denied if not administrative user

Changing the value is denied if any of the following is true:

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueRetainedThe latest message payload should be retained on the broker and sent on subscription
constant falseNot retainedMessages should not be retained on the broker

Sample uom library write command:

uom.mqtt.lwt_retain=true

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/lwt_retain/"

false

Browse more samples

Notifications

objectmqtt/notifications/
MQTT-related notifications
dot_inline_dotgraph_586.png

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kindsParameter kinds
eventsEvents

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/',auth=auth,headers=headers).json())

Sample CLI read command:

uom get "mqtt/notifications"

Browse more samples

See also Notifications: Parameter kinds

Events

mapmqtt/notifications/events/
Event templates
dot_inline_dotgraph_587.png

Retrieving the value is denied if not administrative user

This map is composite, i.e. is modified as a whole.

This map does not support direct modification.

This map contains Event elements.

Creating elements in this collection is not supported.

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/',auth=auth,headers=headers).json())

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/"

Browse more samples

See also Events: Event

Notifications: Parameter kinds

objectmqtt/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

connectedConnection status

Connection status

sum (boolean)mqtt/notifications/parameter_kinds/connected/
Broker connection status

This sum can assume the following values:

constant trueConnectedBroker connection successful
constant falseFailed to connectBroker connection failed

Event parameters: Event parameter

objectmqtt/notifications/events/S/parameters/N/
Properties of a parameter associated with the event

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

idIdentifier
has_fixed_valueFixed value flag
fixed_valueFixed value

Sample requests read command (note that _event and _event_parameter_index are variables):

print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers).json())

{'fixed_value': True, 'has_fixed_value': True, 'id': 'connected'}

Sample curl write command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"fixed_value\":false,\"has_fixed_value\":true,\"id\":\"connected\"}" "http://192.168.0.100/restapi/mqtt/notifications/events/:event/parameters/:event_parameter_index/"

Browse more samples

Identifier

stringmqtt/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_588.png

The value is subject to the following constraints: parameter kinds[the value]

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/:event/parameters/:event_parameter_index/id/"

"connected"

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"mqtt/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/id/"},function(error,response,body) {console.log(body)});

"connected"

Browse more samples

Fixed value flag

sum (boolean)mqtt/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
dot_inline_dotgraph_589.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant trueFixedThe value is fixed
constant falseVariableThe value is variable

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"mqtt/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/has_fixed_value/"},function(error,response,body) {console.log(body)});

true

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/:event/parameters/:event_parameter_index/has_fixed_value/"

true

Browse more samples

Fixed value

sum (variant)mqtt/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
dot_inline_dotgraph_590.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis number

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"mqtt/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/fixed_value/"},function(error,response,body) {console.log(body)});

true

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/:event/parameters/:event_parameter_index/fixed_value/"

false

Browse more samples

Events: Event

objectmqtt/notifications/events/S/
Event template
dot_inline_dotgraph_591.png

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

message_templateMessage template
severitySeverity
parametersEvent parameters

Sample requests write command (note that _event is a variable):

requests.put('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/',auth=auth,headers=headers,json={'severity': 5, 'message_template': ['failed to connect to broker'], 'parameters': [{'fixed_value': False, 'has_fixed_value': True, 'id': 'connected'}]})

Sample CLI read command (note that event is a variable):

uom get "mqtt/notifications/events/${event}"

{"severity":5,"message_template":["failed to connect to broker"],"parameters":[{"fixed_value":false,"has_fixed_value":true,"id":"connected"}]}

Browse more samples

Message template

arraymqtt/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_592.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Message template element elements.

Creating elements in this collection is not supported.

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/message_template/',auth=auth,headers=headers).json())

['failed to connect to broker']

Sample CLI read command (note that event is a variable):

uom get "mqtt/notifications/events/${event}/message_template"

["failed to connect to broker"]

Browse more samples

Message template element

sum (variant)mqtt/notifications/events/S/message_template/N/
Element of human-readable message template
dot_inline_dotgraph_593.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

stringStringFixed string
numberParameterIndex of message parameter to insertevent parameters[the value]

Sample uom library read command (note that _event and _message_template_element_index are variables):

print(uom.dump(uom.mqtt.notifications.events[_event].message_template[_message_template_element_index]))

"connected to broker"

Sample curl read command (note that :event and :message_template_element_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/mqtt/notifications/events/:event/message_template/:message_template_element_index/"

"failed to connect to broker"

Browse more samples

Severity

sum (enumerated number)mqtt/notifications/events/S/severity/
Severity rating assigned to the event
dot_inline_dotgraph_594.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant 1EmergencyTreat the event as an emergency
constant 2AlertTreat the event as an alert
constant 3CriticalTreat the event as critical
constant 4ErrorTreat the event as an error
constant 5WarningTreat the event as a warning
constant 6NoticeTreat the event as a notice
constant 7InformationalTreat the event as informational
constant 8DebugTreat the event as debugging-related

Sample JS request read command (note that _event is a variable):

request.get({url:"mqtt/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});

5

Sample CLI read command (note that event is a variable):

uom get "mqtt/notifications/events/${event}/severity"

6

Browse more samples

Event parameters

arraymqtt/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_595.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Event parameter elements.

Creating elements in this collection is not supported.

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/mqtt/notifications/events/'+_event+'/parameters/',auth=auth,headers=headers).json())

[{'fixed_value': False, 'has_fixed_value': True, 'id': 'connected'}]

Sample uom library read command (note that _event is a variable):

print(uom.dump(uom.mqtt.notifications.events[_event].parameters))

{{fixed_value=true,has_fixed_value=true,id="connected"}}

Browse more samples

See also Event parameters: Event parameter