Skip to main content

system.mes.material.newPropertyValue

Description

Generates an empty non-persisted Material Property Values object to provide the structure required by the API to save a new record into the database. This method must be combined with the savePropertyValue method in order to persist the record.

Permissions

This method does not require any permissions.

Syntax

system.mes.material.newPropertyValue()

Parameters

ParameterTypeNullableDescription
None--This method does not take any parameters.

Returns

Returns a JSON representation of the newly created material property value object. The following is a list of keys and default values:

KeyDefault Value
materialIdnull
materialPropertyIdnull
dataTypeString
valuenull
idnull
notesnull
enabledtrue
spare1null
spare2null
spare3null

Code Examples

# Generate the object structure for a new material object
newMaterial = system.mes.material.newMaterial()
newMaterial['materialClassId'] = '01JCH3ENEB-SV2X8B3W-NFY8WZNK'
newMaterial['name'] = '5391537510212'
newMaterial['unitOfMeasureId'] = '01JCH3ENDJ-351WQQPX-WRBNTY4C'
savedMaterial = system.mes.material.saveMaterial(**newMaterial)

# Generate the object structure for a new property object
newProperty = system.mes.material.newProperty()
newProperty['materialClassId'] = '01JCH3ENEB-SV2X8B3W-NFY8WZNK'
newProperty['name'] = 'Density'
newProperty['dataType'] = 'Float'
savedProperty = system.mes.material.saveProperty(**newProperty)

# Generate the object structure for a new property value object with no initial arguments
newPropertyValue = system.mes.material.newPropertyValue()

# Define property value details
newPropertyValue['materialId'] = savedMaterial.id
newPropertyValue['materialPropertyId'] = savedProperty.id
newPropertyValue['dataType'] = 'Float' # Must be the same data type as the property
newPropertyValue['value'] = 100
# (You can continue setting other properties as needed here)

# Save the property value
savedPropertyValue = system.mes.material.savePropertyValue(**newPropertyValue)

# Output the JSON representation of the saved material property value
print(savedPropertyValue)