system.mes.material.deleteMaterial
Description
Deletes a Materials record by its ID or path. This cannot delete a material with references to it.
Permissions
This method requires the MATERIAL.WRITE.DELETE permission.
Syntax
system.mes.material.deleteMaterial(idOrPath)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
idOrPath | String | False | The ID or path of the material to delete. |
Returns
If successful, an ApiResponse Object is returned with the success bool set True. If unsuccessful, an IllegalArgumentException or ConstraintViolationException is thrown. If the material that's 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 a material by ID or path
system.mes.material.deleteMaterial('IRB/5391537510212')