Skip to main content

system.mes.equipment.deleteEquipmentPropertyValueFor

Description

Deletes an Equipment Property Values record identified by an equipment and property.

Permissions

This method requires the EQUIPMENT.WRITE.DELETE permission.

Syntax

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

Parameters

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

Returns

If successful, an ApiResponse Object is returned with the success bool set True.

NameTypeDescription
successBooleanIndicates if the delete was successful.
messageStringThe reason why the deletion was successful or unsuccessful.
dataStringThe data associated with the deletion.
errorStringThe errors associated with the deletion.

Code Examples

# Delete by path and property name
system.mes.equipment.deleteEquipmentPropertyValueFor('Pumps/CentrifugalPumps/Pump-101', 'MaxFlowRate')

# Delete by equipment ID and property ID
system.mes.equipment.deleteEquipmentPropertyValueFor('01ARZ3NDEKTSV4RRFFQ69G5FAV', '01ARZ3NDEKTSV4RRFFQ69G5FAW')