system.mes.location.validateLocation

Description

Validates the specified parameters for a Locations record and returns any validation errors. This only checks if the location object can be saved based on the attributes given.

Syntax

system.mes.location.validateLocation(**location_data)

Parameters

Parameter	Type	Description
name	String	The name of the location.
description	String	A detailed description of the location.
parentId	String (ULID)	The ULID of the parent location.
type	String	The type of the location (e.g., ENTERPRISE, COMPANY, SITE, AREA, LINE, CELL_GROUP, CELL, UNIT).
processType	String	The process type for the location (e.g., STORAGE, CONTINUOUS, BATCH, DISCRETE, NONE).
sortOrder	Integer	Determines the display order of the location.
allowNegativeInventory	Boolean	Allows inventory to go negative at this location.
storageCapacity	Double	Maximum storage capacity allowed at the location.
storageCapacityUnitId	String (ULID)	The ULID for the storage capacity unit to be used as the default unit of measure for this location. See unit_of_measure.
lotStorageStrategy	String	Defines the lot storage strategy (e.g, ALLOW_MULTIPLE, ALLOW_SINGLE_OR_THROW, MERGE_INTO_PREVIOUS, MERGE_INTO_NEW, NO_STORAGE).
lotUseStrategy	String	Defines the lot usage strategy, such as FIFO or FEFO.
path	String	Path of the location within the hierarchy.
id	String (ULID)	The ULID of the location (optional, used for updating an existing location).
notes	String	Notes related to the location.
enabled	Boolean	Indicates if the location is active and enabled.
spare1	String	Additional field for user-defined context.
spare2	String	Additional field for user-defined context.
spare3	String	Additional field for user-defined context.

Returns

Returns a JSON object where keys are field names and values are lists of validation violation messages.

Code Examples

# Generate the object structure for a new location object
location_data = system.mes.location.newLocation()

# Set basic attributes for the new location
location_data['name'] = 'Warehouse'
location_data['description'] = 'Main storage location for raw materials.'
location_data['type'] = 'AREA'
location_data['processType'] = 'STORAGE'
location_data['sortOrder'] = 1
# (You can continue setting other properties as needed here)

# Validate location parameters
validation_errors = system.mes.location.validateLocation(**location_data)

if len(validation_errors) > 0:
    print('Validation errors found:', validation_errors)
else:
    print('Location parameters are valid.')