system.mes.equipment.newEquipmentProperty
Description
Generates an empty non-persisted Equipment Properties object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveEquipmentProperty method in order to persist the record.
Permissions
This method does not require any permissions.
Syntax
system.mes.equipment.newEquipmentProperty()
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
| None | - | - | This method does not take any parameters. |
Returns
Returns a JSON representation of the newly created equipment property object. The following is a list of keys and default values:
| Key | Default Value |
|---|---|
name | null |
description | null |
dataType | String |
lowLimit | null |
highLimit | null |
format | null |
unitOfMeasureId | null |
unitOfMeasureName | null |
unitOfMeasureSymbol | null |
options | null |
nullable | true |
defaultValue | null |
id | null |
notes | null |
enabled | true |
spare1 | null |
spare2 | null |
spare3 | null |
Code Examples
newProperty = system.mes.equipment.newEquipmentProperty()
newProperty['name'] = 'MaxFlowRate'
newProperty['description'] = 'Maximum flow rate in liters per minute.'
newProperty['dataType'] = 'Float8'
savedProperty = system.mes.equipment.saveEquipmentProperty(**newProperty)
print(savedProperty)