system.mes.material.newMaterial
Description
Generates an empty non-persisted Materials object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveMaterial method in order to persist the record.
Permissions
This method does not require any permissions.
Syntax
system.mes.material.newMaterial()
Parameters
| Parameter | Type | Nullable | Description |
|---|---|---|---|
| None | - | - | This method does not take any parameters. |
Returns
Returns a JSON representation of the newly created material object. The following is a list of keys and default values:
| Key | Default Value |
|---|---|
name | null |
description | null |
path | null |
materialClassId | null |
erpId | null |
unitOfMeasureId | null |
shelfLifeDays | null |
id | null |
notes | null |
enabled | true |
spare1 | null |
spare2 | null |
spare3 | null |
Code Examples
# Generate the object structure for a new material object with no initial arguments
newMaterial = system.mes.material.newMaterial()
# Set basic attributes for the new material
newMaterial['materialClassId'] = '01JCH3ENEB-SV2X8B3W-NFY8WZNK'
newMaterial['name'] = '5391537510212'
newMaterial['unitOfMeasureId'] = '01JCH3ENDJ-351WQQPX-WRBNTY4C'
# (You can continue setting other properties as needed here)
# Save the new material to the system
savedMaterial = system.mes.material.saveMaterial(**newMaterial)
# Output the JSON representation of the saved material
print(savedMaterial)