system.mes.equipment.getEquipmentProperty

Description

Retrieves an Equipment Properties record by its ID or name.

Permissions

This method requires the EQUIPMENT.READ.GET permission.

Syntax

system.mes.equipment.getEquipmentProperty(idOrName)

Parameters

Parameter	Type	Nullable	Description
idOrName	String	False	The ID or name of the equipment property to retrieve.

Returns

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

Name	Type	Description
name	String	The name of the equipment property.
description	String	A description of the equipment property.
dataType	String	The data type of the property (e.g., String, Boolean, Int8, Float8, DateTime, ByteArray).
lowLimit	Double	The minimum allowed value. Only applicable for numeric data types.
highLimit	Double	The maximum allowed value. Only applicable for numeric data types.
format	String	An optional format string for display.
unitOfMeasureId	String (ULID)	The ULID of the unit of measure for this property.
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 for the property.
nullable	Boolean	Whether the property value can be null.
defaultValue	Mixed	The default value for the property. The type depends on the configured dataType.
id	String (ULID)	The ULID of the equipment property.
notes	String	Notes related to the equipment property.
enabled	Boolean	Indicates if the equipment property is active.
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

# Retrieve by name
property = system.mes.equipment.getEquipmentProperty('MaxFlowRate')
print(property)

# Retrieve by ID
property = system.mes.equipment.getEquipmentProperty('01ARZ3NDEKTSV4RRFFQ69G5FAV')
print(property)