system.mes.equipment.saveEquipmentClass
Description
Creates or updates an Equipment Classes record in the system based on the provided parameters.
Permissions
This method requires the EQUIPMENT.WRITE.SAVE permission.
Syntax
system.mes.equipment.saveEquipmentClass(**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 representation of the saved equipment class.
Code Examples
newClass = system.mes.equipment.newEquipmentClass()
newClass['name'] = 'CentrifugalPumps'
newClass['description'] = 'High-speed centrifugal pumps.'
savedClass = system.mes.equipment.saveEquipmentClass(**newClass)
print(savedClass)