system.mes.location.newProperty
Description
Generates an empty non-persisted Location Properties object to provide the structure required by the API to save a new record into the database. This method must be combined with the saveProperty method in order to persist the record.
Syntax
system.mes.location.newProperty()
Parameters
| Parameter | Type | Description |
|---|---|---|
| None | - | This method does not take any parameters. |
Returns
Returns a JSON representation of the newly created location property object. The following is a list of keys and default values:
| Key | Default Value |
|---|---|
name | null |
description | null |
dataType | String |
lowLimit | null |
highLimit | null |
format | null |
unitOfMeasureId | null |
unitOfMeasureName | null |
unitOfMeasureSymbol | null |
options | null |
nullable | false |
defaultValue | null |
id | null |
notes | null |
enabled | true |
spare1 | null |
spare2 | null |
spare3 | null |
Code Examples
# Generate the object structure for a new property object with no initial arguments
new_property = system.mes.location.newProperty()
# Define property details
new_property['name'] = 'Temperature'
new_property['dataType'] = 'Float'
new_property['unitOfMeasureId'] = '01JAP8RJBN-4VYZUKE1-LY2QHV8X'
new_property['nullable'] = False
new_property['lowLimit'] = -20
new_property['highLimit'] = 50
# (You can continue setting other properties as needed here)
# Save the property
saved_property = system.mes.location.saveProperty(**new_property)
# Output the JSON representation of the saved property
print(saved_property)