system.mes.equipment.deleteEquipmentProperty
Description
Deletes an Equipment Properties record by its ID or name. This cannot delete an equipment property with references to it.
Permissions
This method requires the EQUIPMENT.WRITE.DELETE permission.
Syntax
system.mes.equipment.deleteEquipmentProperty(idOrName)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
idOrName | String | False | The ID or name of the equipment property to delete. |
Returns
If successful, an ApiResponse Object is returned with the success bool set True. If the property being deleted has a reference, an ApiResponse Object is returned with details about the encountered error.
| Name | Type | Description |
|---|---|---|
success | Boolean | Indicates if the delete was successful. |
message | String | The reason why the deletion was successful or unsuccessful. |
data | String | The data associated with the deletion. |
error | String | The errors associated with the deletion. |
Code Examples
# Delete by name
system.mes.equipment.deleteEquipmentProperty('MaxFlowRate')
# Delete by ID
system.mes.equipment.deleteEquipmentProperty('01ARZ3NDEKTSV4RRFFQ69G5FAV')