system.mes.equipment.getEquipmentClass
Description
Retrieves an Equipment Classes record by its ID or path.
Permissions
This method requires the EQUIPMENT.READ.GET permission.
Syntax
system.mes.equipment.getEquipmentClass(idOrPath)
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
idOrPath | String | False | The ID or path of the equipment class to retrieve. |
Returns
Returns a JSON representation of the equipment class. Returns nothing if no equipment class is found.
| Name | Type | Description |
|---|---|---|
name | String | The name of the equipment class. |
description | String | A description of the equipment class. |
parentId | String (ULID) | The ULID of the parent equipment class. |
path | String | The path of the equipment class within the hierarchy. |
id | String (ULID) | The ULID of the equipment class. |
notes | String | Notes related to the equipment class. |
enabled | Boolean | Indicates if the equipment class is active and enabled. |
spare1 | String | Additional field for user-defined context. |
spare2 | String | Additional field for user-defined context. |
spare3 | String | Additional field for user-defined context. |
Code Examples
equipmentClass = system.mes.equipment.getEquipmentClass('Pumps/CentrifugalPumps')
print(equipmentClass)