Skip to main content

system.mes.equipment.deleteEquipmentPropertyValuesFor

Description

Deletes multiple Equipment Property Values records for a specific equipment, identified by property IDs or names.

Permissions

This method requires the EQUIPMENT.WRITE.DELETE permission.

Syntax

system.mes.equipment.deleteEquipmentPropertyValuesFor(equipmentIdOrPath, propertyIdOrNames)

Parameters

ParameterTypeNullableDescription
equipmentIdOrPathStringFalseThe ID or path of the equipment.
propertyIdOrNamesList<String>FalseA list of equipment property IDs or names to delete values for.

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 names
system.mes.equipment.deleteEquipmentPropertyValuesFor('Pumps/CentrifugalPumps/Pump-101', ['MaxFlowRate', 'MinFlowRate'])

# Delete by equipment ID and property IDs
system.mes.equipment.deleteEquipmentPropertyValuesFor('01ARZ3NDEKTSV4RRFFQ69G5FAV', ['01ARZ3NDEKTSV4RRFFQ69G5FAW', '01ARZ3NDEKTSV4RRFFQ69G5FAX'])