Skip to main content

system.mes.material.deleteMaterials

Description

Deletes all Materials records by the given IDs or paths. This cannot delete any materials with references to it.

Syntax

system.mes.material.deleteMaterials(idsOrPaths)

Parameters

ParameterTypeDescription
idsOrPathsList<String>List of IDs or paths of the materials 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.

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 all materials by the given IDs or paths
system.mes.material.deleteMaterials(['IRB/5391537510212', 'RAW/FLAV/050005 575T'])