DLI DC3 Object Model Reference
20210819T152642Z
Scripting server object
objectscript/
Object representing the scripting server state and configuration
dot_inline_dotgraph_465.png

Retrieving the value is denied if not administrative user

This object contains the following items:

sourceUser script source
snippetsScript snippets
user_functionsUser functions
user_function_ui_orderUser function UI order
boot_handlerScript to start at startup, if any
boot_handler_legacyLegacy startup handling
threadsThread map
startStart a script thread
stopStop a script thread
variablesScript external variables
tracedScript tracing
step_delayScript step delay
step_time_limitScript step time limit
notificationsNotifications

Sample requests write command:

requests.put('http://192.168.0.100/restapi/script/',auth=auth,headers=headers,json=<...>)

Sample curl read command:

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

...

Browse more samples

User script source

stringscript/source/
Source of the user script from which user functions are extracted
dot_inline_dotgraph_466.png

The value contains Lua source (has native MIME type text/x-lua).

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample requests write command:

requests.put('http://192.168.0.100/restapi/script/source/',auth=auth,headers=headers,json='function enable_engines(...)\n  ...\nend\nfunction cycle_appliance(...)\n  ...\nend\nfunction cycle_routers(...)\n  ...\nend\n')

Sample requests read command:

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

'function cycle_gadget(...)\n  ...\nend\n'

Browse more samples

Script snippets

mapscript/snippets/
Fragments of Lua code provided initially as samples or saved for later use
dot_inline_dotgraph_467.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

Changes to this map cannot be tracked.

This map contains Script snippet elements.

Sample JS request read command:

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

{"enable_machine_sample":{"source":"function energize_gadget(...)\n  ...\nend\nfunction disable_router(...)\n  ...\nend\nfunction enable_gadget(...)\n  ...\nend\nfunction energize_heaters(...)\n  ...\nend\nfunction energize_engines(...)\n  ...\nend\n"}}

Sample uom library script snippet creation command:

uom.insert(uom.script.snippets,"toggle_engine_sample",{source="function shut_down_modem(...)\
  ...\
end\
function disable_engines(...)\
  ...\
end\
function toggle_engine(...)\
  ...\
end\
"})

Browse more samples

See also Script snippets: Script snippet

Script snippets: Script snippet

objectscript/snippets/S/
User script snippet

This object contains the following items:

sourceSnippet source

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

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

{"source":"function shut_down_appliance(...)\n  ...\nend\nfunction shut_down_machines(...)\n  ...\nend\nfunction toggle_router(...)\n  ...\nend\nfunction toggle_appliances(...)\n  ...\nend\n"}

Sample curl write command (note that :script_snippet 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 "{\"source\":\"function enable_heaters(...)\\n  ...\\nend\\nfunction energize_contraption(...)\\n  ...\\nend\\nfunction energize_gadget(...)\\n  ...\\nend\\nfunction enable_contraption(...)\\n  ...\\nend\\nfunction toggle_routers(...)\\n  ...\\nend\\n\"}" "http://192.168.0.100/restapi/script/snippets/:script_snippet/"

Browse more samples

Snippet source

stringscript/snippets/S/source/
Source of the snippet
dot_inline_dotgraph_468.png

The value contains Lua source (has native MIME type text/x-lua).

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Changes to this string cannot be tracked.

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

print(requests.get('http://192.168.0.100/restapi/script/snippets/'+_script_snippet+'/source/',auth=auth,headers=headers).json())

'function toggle_engines(...)\n  ...\nend\nfunction shut_down_heaters(...)\n  ...\nend\n'

Sample uom library write command (note that _script_snippet is a variable):

uom.script.snippets[_script_snippet].source="function cycle_router(...)\
  ...\
end\
function shut_down_heater(...)\
  ...\
end\
"

Browse more samples

User functions

mapscript/user_functions/
Mapping of user function names to their signatures
dot_inline_dotgraph_469.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 can change as if by itself or indirectly because of other actions.

Changes to this map cannot be tracked.

This map contains User script function signature elements.

Creating elements in this collection is not supported.

Sample uom library read command:

print(uom.dump(uom.script.user_functions))

{}

Sample requests read command:

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

{}

Browse more samples

User script function signature

stringscript/user_functions/S/
Indicates that the map key is a user script function, and provides a signature which may serve as a hint as to the function content
dot_inline_dotgraph_470.png

The value is subject to the following constraints: not index of the value matches ^(|​.*|.*)$

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 CLI read command (note that user_script_function_signature is a variable):

uom get "script/user_functions/${user_script_function_signature}"

[]

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

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

[]

Browse more samples

User function UI order

arrayscript/user_function_ui_order/
Preferred order of user functions when displayed to user
dot_inline_dotgraph_471.png

Retrieving the value is denied if not administrative user

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

This array does not support direct modification.

This array can change as if by itself or indirectly because of other actions.

Changes to this array cannot be tracked.

This array contains User script function name for index elements.

Creating elements in this collection is not supported.

Sample JS request read command:

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

["toggle_appliance","energize_heater"]

Sample uom library read command:

print(uom.dump(uom.script.user_function_ui_order))

{"disable_routers"}

Browse more samples

User script function name for index

stringscript/user_function_ui_order/N/
Indicates that the preferred location of this user function in a list is the index in the array; may specify a nonexistent function
dot_inline_dotgraph_472.png

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 uom library read command (note that _user_script_function_name_for_index_index is a variable):

print(uom.dump(uom.script.user_function_ui_order[_user_script_function_name_for_index_index]))

"toggle_gadget"

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

request.get({url:"script/user_function_ui_order/"+_user_script_function_name_for_index_index.toString()+"/"},function(error,response,body) {console.log(body)});

"cycle_appliance"

Browse more samples

Script to start at startup, if any

sum (string)script/boot_handler/
User scripting function to run at startup, if any
dot_inline_dotgraph_473.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

stringScript to start at startupUser scripting function to run at startup, with the startup reason as argument (or only at cold boot if configured to)user functions[the value]
constant ""NoneDon't run any scripting function at startup

Sample uom library write command:

uom.script.boot_handler=""

Sample requests read command:

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

''

Browse more samples

Legacy startup handling

sum (boolean)script/boot_handler_legacy/
Run startup script only on cold boot and omit the argument
dot_inline_dotgraph_474.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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 read command:

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

false

Sample requests write command:

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

Browse more samples

Thread map

mapscript/threads/
Map of user scripting threads
dot_inline_dotgraph_475.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 can change as if by itself or indirectly because of other actions.

Changes to this map cannot be tracked.

This map contains Scripting thread elements.

Creating elements in this collection is not supported.

Sample requests read command:

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

Sample uom library read command:

print(uom.dump(uom.script.threads))

{["90"]={label="label of thread #90"}}

Browse more samples

See also Thread map: Scripting thread

Thread map: Scripting thread

objectscript/threads/S/
User scripting thread status

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

This object contains the following items:

labelLabel

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

requests.put('http://192.168.0.100/restapi/script/threads/'+_scripting_thread+'/',auth=auth,headers=headers,json={'label': 'label of thread #16'})

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

uom get "script/threads/${scripting_thread}"

{"label":"label of thread #44"}

Browse more samples

Label

stringscript/threads/S/label/
User thread label
dot_inline_dotgraph_476.png

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 :scripting_thread is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/script/threads/:scripting_thread/label/"

"label of thread #12"

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

print(requests.get('http://192.168.0.100/restapi/script/threads/'+_scripting_thread+'/label/',auth=auth,headers=headers).json())

'label of thread #50'

Browse more samples

Start a script thread

callscript/start/
Start a user scripting thread
dot_inline_dotgraph_477.png

Performing the function call is denied if not administrative user

The call accepts the following arguments:

  1. Code source: object "Code source"

The call returns the following results:

  1. Resulting thread ID: string

Sample requests invocation:

print(requests.post('http://192.168.0.100/restapi/script/start/',auth=auth,headers=headers,json=[{'source': 'fn("engine")', 'user_function': 'cycle_contraptions'}]).json())

'4'

Sample curl invocation:

curl --digest -u admin:1234 -H "X-CSRF: x" -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[{\"source\":\"fn(\\\"gadget\\\",7,9,\\\"appliance\\\")\",\"user_function\":\"disable_machines\"}]" "http://192.168.0.100/restapi/script/start/"

"26"

Browse more samples

See also Start a script thread: Code source

Resulting thread ID

stringscript/start/results: 1/
Identifier of the started thread
dot_inline_dotgraph_478.png

The value is subject to the following constraints: thread map[the value]

This string does not correspond to an actual resource.

Start a script thread: Code source

objectscript/start/arguments: 1/
Source of the code to run

This object does not correspond to an actual resource.

This object contains the following items:

user_functionUser function, if any
sourceUser code, if any
displayed_sourceDisplayed source code, if any

User function, if any

sum (optional string)script/start/arguments: 1/user_function/
Name of user function to run, if any
dot_inline_dotgraph_479.png

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant nullNo user function is runThe source of code is not a user function
stringUser functionName of user function to runuser functions[the value]

User code, if any

sum (optional string)script/start/arguments: 1/source/
Explicit code to run as user script (if user_function is not set or is an existing user script function), if any

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant nullUser function invocationThe user_function is invoked with no arguments
stringUser codeExplicit code to run as user script (if user_function is not set or is an existing user script function)

Displayed source code, if any

sum (optional string)script/start/arguments: 1/displayed_source/
Source code describing thread overview (doesn't have to be valid code), if any

This sum does not correspond to an actual resource.

This sum can assume the following values:

constant nullUse defaultDisplay source, or user_function name
stringDisplayed source codeSource code describing thread overview (doesn't have to be valid code)

Stop a script thread

callscript/stop/
Stop a user scripting thread, or all user scripting threads
dot_inline_dotgraph_480.png

Performing the function call is denied if not administrative user

The call accepts the following arguments:

  1. Thread(s) to stop: Thread ID or All threads

The call returns the following results:

  1. Empty result: null

Sample requests invocation:

requests.post('http://192.168.0.100/restapi/script/stop/',auth=auth,headers=headers,json=['12'])

(no output)

Sample uom library invocation:

uom.script.stop("9")

(no output)

Browse more samples

Thread(s) to stop

sum (string)script/stop/arguments: 1/
Identifier of the thread to stop, or "all" to stop all threads
dot_inline_dotgraph_481.png

This sum does not correspond to an actual resource.

This sum can assume the following values:

stringThread IDIdentifier of the thread to stopthread map[the value]
constant "all"All threadsStop all threads

Empty result

constant nullscript/stop/results: 1/
No additional information available

This constant does not correspond to an actual resource.

Script external variables

mapscript/variables/
Elements of the script's external table

This map can change as if by itself or indirectly because of other actions.

This map contains Script external variable elements.

Sample uom library script external variable creation command:

uom.insert(uom.script.variables,"gadget_temperature",true)

Sample requests read command:

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

{'appliance_state': 2}

Browse more samples

Script external variable

sum (variant)script/variables/S/
Element of the script's external table

This sum can change as if by itself or indirectly because of other actions.

This sum can assume the following values:

constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis number

Sample CLI write command (note that script_external_variable is a variable):

uom set "script/variables/${script_external_variable}" "\"no\""

Sample requests deletion command (note that _script_external_variable is a variable):

requests.delete('http://192.168.0.100/restapi/script/variables/'+_script_external_variable+'/',auth=auth,headers=headers)

Browse more samples

Script tracing

sum (boolean)script/traced/
Perform step-by-step logging of script operation
dot_inline_dotgraph_482.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

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 read command:

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

false

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 "false" "http://192.168.0.100/restapi/script/traced/"

Browse more samples

Script step delay

numberscript/step_delay/
Delay after executing legacy scripting functions
dot_inline_dotgraph_483.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample JS request read command:

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

3

Sample uom library read command:

print(uom.dump(uom.script.step_delay))

3

Browse more samples

Script step time limit

numberscript/step_time_limit/
Maximum amount of time a scripting thread is allowed to run uninterrupted
dot_inline_dotgraph_484.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater than 0

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample JS request read command:

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

15

Sample uom library write command:

uom.script.step_time_limit=20

Browse more samples

Notifications

objectscript/notifications/
Scripting server notifications
dot_inline_dotgraph_485.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 CLI read command:

uom get "script/notifications"

...

Sample requests read command:

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

<...>

Browse more samples

Parameter kinds

objectscript/notifications/parameter_kinds/
Kinds of event parameters
dot_inline_dotgraph_486.png

This object does not correspond to an actual resource.

This object contains the following items:

script_messageScript message
script_dataScript data
thread_idThread ID
thread_nameThread name
thread_originThread origin, if any
thread_start_reasonThread start reason, if any
thread_stop_reasonThread stop reason
thread_stateThread state
thread_errorThread error

See also Parameter kinds: Script message

See also Parameter kinds: Script data

See also Parameter kinds: Thread ID

See also Parameter kinds: Thread name

See also Parameter kinds: Thread origin, if any

See also Parameter kinds: Thread start reason, if any

See also Parameter kinds: Thread stop reason

See also Parameter kinds: Thread state

See also Parameter kinds: Thread error

Events

mapscript/notifications/events/
Event templates
dot_inline_dotgraph_487.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 curl read command:

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

...

Sample uom library read command:

print(uom.dump(uom.script.notifications.events))

<...>

Browse more samples

See also Events: Event

Parameter kinds: Script message

stringscript/notifications/parameter_kinds/script_message/
Message for the script-generated event

Parameter kinds: Script data

mapscript/notifications/parameter_kinds/script_data/
Data of the script-generated event

This map contains Script data element elements.

Script data element

sum (variant)script/notifications/parameter_kinds/script_data/S/
Element of script-generated event data

This sum can assume the following values:

constant nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis number

Parameter kinds: Thread ID

stringscript/notifications/parameter_kinds/thread_id/
Thread identifier

Parameter kinds: Thread name

stringscript/notifications/parameter_kinds/thread_name/
Thread human-readable name

Parameter kinds: Thread origin, if any

sum (optional string)script/notifications/parameter_kinds/thread_origin/
Origin of the thread, if any

This sum can assume the following values:

constant nullUnknown originOrigin of this thread is not known
stringThread originOrigin of the thread

Parameter kinds: Thread start reason, if any

sum (optional string)script/notifications/parameter_kinds/thread_start_reason/
Reason of the thread start, if any

This sum can assume the following values:

constant nullUnknown start reasonReason of the thread start is not known
stringThread start reasonReason of the thread start

Parameter kinds: Thread stop reason

stringscript/notifications/parameter_kinds/thread_stop_reason/
Reason of the thread stop

Parameter kinds: Thread state

sum (boolean)script/notifications/parameter_kinds/thread_state/
Thread execution state

This sum can assume the following values:

constant trueRunningThe thread is running
constant falseStoppedThe thread is stopped

Parameter kinds: Thread error

stringscript/notifications/parameter_kinds/thread_error/
Thread execution error description

Event parameters: Event parameter

objectscript/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 CLI read command (note that event and event_parameter_index are variables):

uom get "script/notifications/events/${event}/parameters/${event_parameter_index}"

{"fixed_value":true,"has_fixed_value":true,"id":"thread_state"}

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

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

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

Browse more samples

Identifier

stringscript/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_488.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 uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.script.notifications.events[_event].parameters[_event_parameter_index].id))

"thread_name"

Sample CLI read command (note that event and event_parameter_index are variables):

uom get "script/notifications/events/${event}/parameters/${event_parameter_index}/id"

"thread_id"

Browse more samples

Fixed value flag

sum (boolean)script/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
dot_inline_dotgraph_489.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 uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.script.notifications.events[_event].parameters[_event_parameter_index].has_fixed_value))

false

Sample CLI read command (note that event and event_parameter_index are variables):

uom get "script/notifications/events/${event}/parameters/${event_parameter_index}/has_fixed_value"

false

Browse more samples

Fixed value

sum (variant)script/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
dot_inline_dotgraph_490.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 uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.script.notifications.events[_event].parameters[_event_parameter_index].fixed_value))

null

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

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

null

Browse more samples

Events: Event

objectscript/notifications/events/S/
Event template
dot_inline_dotgraph_491.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 curl read command (note that :event is a URL template argument):

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

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

requests.put('http://192.168.0.100/restapi/script/notifications/events/'+_event+'/',auth=auth,headers=headers,json={'severity': 4, 'message_template': [0, ':', 1, ' [', 2, '] (', 3, ') failed: ', 4], 'parameters': [{'fixed_value': None, 'has_fixed_value': False, 'id': 'thread_id'}, {'fixed_value': None, 'has_fixed_value': False, 'id': 'thread_name'}, {'fixed_value': None, 'has_fixed_value': False, 'id': 'thread_origin'}, {'fixed_value': None, 'has_fixed_value': False, 'id': 'thread_start_reason'}, {'fixed_value': None, 'has_fixed_value': False, 'id': 'thread_error'}]})

Browse more samples

Message template

arrayscript/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_492.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 JS request read command (note that _event is a variable):

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

[0,":",1," [",2,"] (",3,") failed: ",4]

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

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

{0,":",1," [",2,"] (",3,") failed: ",4}

Browse more samples

Message template element

sum (variant)script/notifications/events/S/message_template/N/
Element of human-readable message template
dot_inline_dotgraph_493.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 CLI read command (note that event and message_template_element_index are variables):

uom get "script/notifications/events/${event}/message_template/${message_template_element_index}"

2

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

request.get({url:"script/notifications/events/"+_event+"/message_template/"+_message_template_element_index.toString()+"/"},function(error,response,body) {console.log(body)});

"] ("

Browse more samples

Severity

sum (enumerated number)script/notifications/events/S/severity/
Severity rating assigned to the event
dot_inline_dotgraph_494.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:"script/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});

4

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

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

5

Browse more samples

Event parameters

arrayscript/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_495.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/script/notifications/events/'+_event+'/parameters/',auth=auth,headers=headers).json())

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

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

Browse more samples

See also Event parameters: Event parameter