Skip to main content
Version: V2 (Ignition 8.1)

system.mes.equipment.newEquipmentPropertyValue

Description​

Generates an empty non-persisted Equipment Property Values object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveEquipmentPropertyValue method in order to persist the record.

Permissions​

This method does not require any permissions.

Syntax​

system.mes.equipment.newEquipmentPropertyValue()

Parameters​

ParameterTypeNullableDescription
None--This method does not take any parameters.

Returns​

Returns a JSON representation of the newly created equipment property value object. The following is a list of keys and default values:

KeyDefault Value
equipmentIdnull
equipmentPropertyIdnull
dataTypeString
valuenull
idnull
notesnull
enabledtrue
spare1null
spare2null
spare3null

Code Examples​

newValue = system.mes.equipment.newEquipmentPropertyValue()
newValue['equipmentId'] = system.mes.equipment.getEquipment('Pumps/CentrifugalPumps/Pump-101')['id']
newValue['equipmentPropertyId'] = system.mes.equipment.getEquipmentProperty('MaxFlowRate')['id']
newValue['value'] = 250.0
savedValue = system.mes.equipment.saveEquipmentPropertyValue(**newValue)
print(savedValue)