system.mes.productionOrder.getProductionOrderPropertyOrCreateNew

Description

Retrieves a Production Order Properties record if an existing production order property exists with the specified ID or name. Otherwise, creates a new Production Order Properties record with the specified name and attributes.

Syntax

system.mes.productionOrder.getProductionOrderPropertyOrCreateNew(**property_data)

Parameters

Parameter	Type	Nullable	Description
name	String	False	The name of the production order property.
description	String	True	A description of the production order property.
dataType	String	False	The data type of the property (e.g., Integer, String, Float). Default value is String
lowLimit	Double	True	The minimum value allowed for a numerical property.
highLimit	Double	True	The maximum value allowed for a numerical property.
format	String	True	The format of the property, if applicable.
unitOfMeasureId	String (ULID)	True	The ULID of the unit of measure for this production order property.
unitOfMeasureName	String	True	The name of the unit of measure for the production order property. For display purposes only.
unitOfMeasureSymbol	String	True	The symbol of the unit of measure for the production order property. For display purposes only.
options	String	True	List of possible values for the property (e.g., "[option1, option2]").
nullable	Boolean	False	Defines if the property can accept null values. Default value is false
defaultValue	Mixed	True	The default value assigned to the property if none is provided. The type is mixed as it depends on what dataType is.
id	String (ULID)	True	The ULID of the production order property (optional, for retrieving the existing property).
notes	String	True	Notes related to the production order property.
enabled	Boolean	True	Indicates if the property is active and enabled. Default value is true
spare1	String	True	Additional field for user-defined context.
spare2	String	True	Additional field for user-defined context.
spare3	String	True	Additional field for user-defined context.

Returns

Returns a JSON representation of the production order property.

Code Examples

# Generate the object structure for a new production order property object
production_order_property = system.mes.productionOrder.newProductionOrderProperty()

# Define property details
production_order_property['name'] = 'Batch Size'
production_order_property['description'] = 'Batch size property'
# (You can continue setting other properties as needed here)

# Get the property if it exists, otherwise creates it with the given attributes
property = system.mes.productionOrder.getProductionOrderPropertyOrCreateNew(**production_order_property)

# Output the JSON representation of the property
print(property)