Skip to main content
Version: V3 (Ignition 8.3)

system.mes.equipment.deleteAllEquipmentProperties

Description​

Deletes multiple Equipment Properties records by their IDs or names.

Permissions​

This method requires the EQUIPMENT.WRITE.DELETE permission.

Syntax​

system.mes.equipment.deleteAllEquipmentProperties(idsOrNames)

Parameters​

ParameterTypeNullableDescription
idsOrNamesString[]FalseAn array of equipment property IDs or names to delete.

Returns​

If successful, an ApiResponse Object is returned with the success bool set True. If any of the properties being deleted have references, an ApiResponse Object is returned with details about the encountered error.

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 name
system.mes.equipment.deleteAllEquipmentProperties(['MaxFlowRate', 'MinFlowRate'])

# Delete by ID
system.mes.equipment.deleteAllEquipmentProperties(['01ARZ3NDEKTSV4RRFFQ69G5FAV', '01ARZ3NDEKTSV4RRFFQ69G5FAW'])