Skip to main content

system.mes.dashboard.getParameterTypeByName

Description

Retrieves a Dashboard Widget Parameter Type by its unique name.

Syntax

system.mes.dashboard.getParameterTypeByName(name)

Parameters

ParameterTypeNullableDescription
nameStringFalseThe name of the parameter type to retrieve.

Returns

Returns a JSON representation of the parameter type.

NameTypeDescription
nameStringThe unique name of the parameter type.
viewPathStringPerspective view path used to edit this parameter type.
idString (ULID)The ULID of the parameter type.
notesStringNotes related to the parameter type.
enabledBooleanIndicates if the parameter type is active and enabled.
spare1StringAdditional field for user-defined context.
spare2StringAdditional field for user-defined context.
spare3StringAdditional field for user-defined context.

Code Examples

pt = system.mes.dashboard.getParameterTypeByName('Integer')
print(pt)