system.mes.equipment.importPropertiesFromJson

Description

Imports Equipment Properties records from a JSON file provided as a string or as raw bytes.

Recommended to export at least one pre-existing equipment property to JSON using the exportPropertiesAsJson functionality to ensure the correct format.

Permissions

This method requires the EQUIPMENT.WRITE.SAVE permission.

Syntax

system.mes.equipment.importPropertiesFromJson(importString)
system.mes.equipment.importPropertiesFromJson(importBytes)

Parameters

Parameter	Type	Nullable	Description
importString	String	False	The JSON content as a string.
importBytes	PyArray	False	The JSON content as raw bytes.

Returns

Returns an ApiResponse containing import result details.

Name	Type	Description
success	Boolean	Indicates if the import was successful.
message	String	A summary of the import result.
data	String	Details about the imported records.
error	String	Any errors encountered during import.

Code Examples

Bytes

def runAction(self, event):
    jsonBytes = event.file.getBytes()
    system.mes.equipment.importPropertiesFromJson(jsonBytes)

String

def runAction(self, event):
    jsonString = event.file.getString()
    system.mes.equipment.importPropertiesFromJson(jsonString)