Skip to main content

system.mes.dashboard.saveParameterType

Description

Creates or updates a Dashboard Widget Parameter Type in the system based on the provided parameters.

Syntax

system.mes.dashboard.saveParameterType(**parameter_type)

Parameters

ParameterTypeNullableDescription
nameStringFalseThe unique name of the parameter type.
viewPathStringFalsePerspective view path used to edit this parameter type.
idString (ULID)TrueThe ULID of the parameter type (for updates).
notesStringTrueNotes related to the parameter type.
enabledBooleanTrueIndicates if the parameter type is active and enabled.
spare1StringTrueAdditional field for user-defined context.
spare2StringTrueAdditional field for user-defined context.
spare3StringTrueAdditional field for user-defined context.

Returns

Returns a JSON representation of the saved parameter type.

Code Examples

pt = system.mes.dashboard.newParameterType()
pt['name'] = 'Integer'
pt['viewPath'] = 'Mes/Editors/Integer'
saved = system.mes.dashboard.saveParameterType(pt)
print(saved)