system.mes.equipment.getPropertiesAndValuesForEquipment

Description

Retrieves a combined list of all Equipment Properties and their corresponding Equipment Property Values for a given equipment. This is a convenience method that returns both property definitions and values together.

Permissions

This method requires the EQUIPMENT.READ.GET permission.

Syntax

system.mes.equipment.getPropertiesAndValuesForEquipment(idOrPath)

Parameters

Parameter	Type	Nullable	Description
idOrPath	String	False	The ID or path of the equipment.

Returns

Returns a list of JSON objects. Each JSON object contains both property definition and value information:

Name	Type	Description
equipmentId	String (ULID)	The ULID of the equipment.
equipmentPropertyId	String (ULID)	The ULID of the equipment property.
equipmentPropertyValueId	String (ULID)	The ULID of the equipment property value.
name	String	The name of the equipment property.
description	String	A description of the equipment property.
dataType	String	The data type of the property.
lowLimit	Double	The minimum allowed value.
highLimit	Double	The maximum allowed value.
format	String	An optional format string.
unitOfMeasureId	String (ULID)	The ULID of the unit of measure.
unitOfMeasureName	String	The name of the unit of measure.
unitOfMeasureSymbol	String	The symbol of the unit of measure.
options	List<String>	A list of allowed values.
nullable	Boolean	Whether the property value can be null.
defaultValue	Mixed	The default value.
value	Mixed	The current value.
equipmentPropertyNotes	String	Notes on the equipment property.
equipmentPropertyValueNotes	String	Notes on the equipment property value.
equipmentPropertyEnabled	Boolean	Whether the equipment property is enabled.
equipmentPropertyValueEnabled	Boolean	Whether the equipment property value is enabled.

Code Examples

propertiesAndValues = system.mes.equipment.getPropertiesAndValuesForEquipment('Pumps/CentrifugalPumps/Pump-101')
print(propertiesAndValues)