Skip to main content

system.mes.oee.deletePerformanceReason

Description

Deletes an OEE Performance Reason by its unique identifier. This operation will permanently remove the performance reason from the system.

Permissions

This method requires the OEE.WRITE.DELETE permission.

Syntax

system.mes.oee.deletePerformanceReason(id)

Parameters

ParameterTypeNullableDescription
idString (ULID)FalseThe ULID of the performance reason 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 oee performance reason 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 an oee performance reason by ID
system.mes.oee.deletePerformanceReason('01JCH3ENEB-SV2X8B3W-NFY8WZNK')