system.mes.dashboard.getParameterTypeByName
Description
Retrieves a Dashboard Widget Parameter Type by its unique name.
Permissions
This method requires the DASHBOARD.READ.GET permission.
Syntax
system.mes.dashboard.getParameterTypeByName(name)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
name | String | False | The name of the parameter type to retrieve. |
Returns
Returns a JSON representation of the parameter type.
| Name | Type | Description |
|---|---|---|
name | String | The unique name of the parameter type. |
viewPath | String | Perspective view path used to edit this parameter type. |
id | String (ULID) | The ULID of the parameter type. |
notes | String | Notes related to the parameter type. |
enabled | Boolean | Indicates if the parameter type is active and enabled. |
spare1 | String | Additional field for user-defined context. |
spare2 | String | Additional field for user-defined context. |
spare3 | String | Additional field for user-defined context. |
Code Examples
pt = system.mes.dashboard.getParameterTypeByName('Integer')
print(pt)