system.mes.material.saveMaterialClass

Description

Creates or updates a Material Classes record in the system based on the provided parameters.

Syntax

system.mes.material.saveMaterialClass(**materialClassData)

Parameters

Parameter	Type	Nullable	Description
name	String	False	The name of the material class.
description	String	True	The description of the material class.
path	String	True	The path to the material class.
parentId	String (ULID)	True	The ULID of the parent material class to this material class.
id	String (ULID)	True	The ULID of the material class (optional, used for updating an existing material class).
notes	String	True	Notes related to the material class.
enabled	Boolean	True	Indicates if the material class is active and enabled. 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 material class.

Code Examples

# Generate the object structure for a new material class object, set the initial arguments and save it
newMaterialClass = system.mes.material.newMaterialClass()
newMaterialClass['name'] = 'RAW'
savedMaterialClass = system.mes.material.saveMaterialClass(**newMaterialClass)

# Output the JSON representation of the saved material class
print(savedMaterialClass)

# Generate the object structure for another new material class to update the previous material class
materialClassData = system.mes.material.newMaterialClass()

# Set basic attributes for the updated material class
materialClassData['id'] = savedMaterialClass.id
materialClassData['name'] = 'RAW'
materialClassData['description'] = 'Material Class for Raw Materials'
# (You can continue setting other properties as needed here)

# Save the material class to update it in the system
updatedMaterialClass = system.mes.material.saveMaterialClass(**materialClassData)

# Output the JSON representation of the updated material class
print(updatedMaterialClass)