system.mes.equipment.deleteEquipment
Description
Deletes an Equipment record by its ID or path. This cannot delete equipment with references to it.
Permissions
This method requires the EQUIPMENT.WRITE.DELETE permission.
Syntax
system.mes.equipment.deleteEquipment(idOrPath)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
idOrPath | String | False | The ID or path of the equipment to delete. |
Returns
If successful, an ApiResponse Object is returned with the success bool set True. If the equipment 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
system.mes.equipment.deleteEquipment('Pumps/CentrifugalPumps/Pump-101')