Skip to main content

system.mes.material.importMaterialsFromJson

Description​

Imports Materials from a JSON file provided as a string or as raw bytes. The service layer will parse the JSON content and create or update material entities based on the 'name' and 'location' columns.

Recommended to export at least one pre-existing material to JSON using the Export Materials functionality to ensure the correct format of the JSON file.

Syntax​

system.mes.material.importMaterialsFromJson(importString)
system.mes.material.importMaterialsFromJson(importBytes)

Parameters​

Either a string or bytes array representing the JSON content.

ParameterTypeDescription
importStringStringThe JSON content as a string.
importBytesPyArrayThe JSON content as raw bytes.

Returns​

The number of materials successfully imported or updated.

Code Examples​

Here is an example of how to use the importMaterialsFromJson method in the context of a Perspective File Upload Component onFileReceived event handler. Reference Perspective - File Upload Scripting for more information on the onFileReceived event handler.

Bytes​

def runAction(self, event):
	jsonBytes = event.file.getBytes()
	system.mes.material.importMaterialsFromJson(jsonBytes)

String​

def runAction(self, event):
	jsonString = event.file.getString()
	system.mes.material.importFromJson(jsonString)