system.mes.equipment.validateEquipmentClass

Description

Validates the specified parameters for an Equipment Classes record and returns any validation errors. This only checks if the equipment class object can be saved based on the attributes given.

Permissions

This method requires the EQUIPMENT.READ.VALIDATE permission.

Syntax

system.mes.equipment.validateEquipmentClass(**equipmentClassData)

Parameters

Parameter	Type	Nullable	Description
name	String	False	The name of the equipment class.
description	String	True	A description of the equipment class.
parentId	String (ULID)	True	The ULID of the parent equipment class. Null for top-level classes.
path	String	True	The path of the equipment class within the hierarchy.
id	String (ULID)	True	The ULID of the equipment class. Used when updating an existing record.
notes	String	True	Notes related to the equipment class.
enabled	Boolean	True	Indicates if the equipment class is active. Default value is true.
spare1	String	True	Additional field for user-defined context.
spare2	String	True	Additional field for user-defined context.
spare3	String	True	Additional field for user-defined context.

Returns

Returns a JSON object where keys are field names and values are lists of validation violation messages.

Code Examples

classData = system.mes.equipment.newEquipmentClass()
classData['name'] = 'CentrifugalPumps'
validationErrors = system.mes.equipment.validateEquipmentClass(**classData)
if len(validationErrors) > 0:
    print('Validation errors found:', validationErrors)
else:
    print('Equipment class parameters are valid.')