Skip to main content
Version: V3 (Ignition 8.3)

system.mes.unitOfMeasure.deleteUnitOfMeasureConversion

Description​

Deletes a Unit Of Measure Conversions record by its ID. This cannot delete a unit of measure conversion with references to it.

Permissions​

This method requires the UNIT_OF_MEASURE.WRITE.DELETE permission.

Syntax​

system.mes.unitOfMeasure.deleteUnitOfMeasureConversion(id)

Parameters​

ParameterTypeNullableDescription
idString (ULID)FalseThe ID of the unit of measure conversion to delete.

Returns​

If successful, an ApiResponse Object is returned with the success bool set True. If unsuccessful, an InUseException, IllegalArgumentException or ConstraintViolationException is thrown. If the unit of measure conversion 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 a unit of measure conversion by ID
system.mes.unitOfMeasure.deleteUnitOfMeasureConversion('01JCH4NZH2-C7494ZJT-P52KRZEY')