Skip to main content

system.mes.equipment.getValueForEquipmentAndProperty

Description

Retrieves an Equipment Property Values record for a specific equipment and property combination.

Permissions

This method requires the EQUIPMENT.READ.GET permission.

Syntax

system.mes.equipment.getValueForEquipmentAndProperty(equipmentIdOrPath, propertyIdOrName)

Parameters

ParameterTypeNullableDescription
equipmentIdOrPathStringFalseThe ID or path of the equipment.
propertyIdOrNameStringFalseThe ID or name of the equipment property.

Returns

Returns a JSON representation of the equipment property value. Returns nothing if no value is found.

NameTypeDescription
equipmentIdString (ULID)The ULID of the equipment this property value belongs to.
equipmentPropertyIdString (ULID)The ULID of the equipment property that defines this value.
dataTypeStringThe data type of the value.
valueMixedThe actual value. Type depends on the property's data type.
idString (ULID)The ULID of the equipment property value.
notesStringNotes related to the property value.
enabledBooleanIndicates if this property value is active.
spare1StringAdditional field for user-defined context.
spare2StringAdditional field for user-defined context.
spare3StringAdditional field for user-defined context.

Code Examples

value = system.mes.equipment.getValueForEquipmentAndProperty('Pumps/CentrifugalPumps/Pump-101', 'MaxFlowRate')
print(value)