Skip to main content

system.mes.material.importMaterialClassesFromJson

Description

Imports Material Classes 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 class to JSON using the Export Material Classes functionality to ensure the correct format of the JSON file.

Syntax

system.mes.material.importMaterialClassesFromJson(importString)
system.mes.material.importMaterialClassesFromJson(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 material classes successfully imported or updated.

Code Examples

Here is an example of how to use the importMaterialClassesFromJson 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.importMaterialClassesFromJson(jsonBytes)

String

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