Skip to main content

system.mes.inventory.validateEditInventoryQuantityRequest

Validates an edit inventory quantity request based on the provided parameters.

Syntax

system.mes.inventory.validateEditInventoryQuantityRequest(**edit_inventory_quantity_request)

Parameters

ParameterTypeDescription
typeStringThe type of request defined by the LotRecordType Enum. It is internally set and must not be modified, as changes may break functionality.
newQuantityDoubleThe new quantity to be assigned to the inventory.
unitOfMeasureSymbolStringThe symbol of the unit of measure for the quantity.
lotIdOrNameStringThe ID or name of the inventory lot whose quantity is being edited.
materialIdOrPathStringThe ID or path of the material whose quantity is being edited.
sourceLocationIdOrPathStringThe ID or path of the location from the inventory quantity is being edited.
operationIdString (ULID)The ID of the operation editing the quantity of this inventory.
notesStringNotes related to the edit inventory quantity request.
spare1StringAdditional field for user-defined context.
spare2StringAdditional field for user-defined context.
spare3StringAdditional 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 edit inventory quantity request object with no initial arguments
edit_inventory_quantity_request = system.mes.inventory.newEditInventoryQuantityRequest()

# Set basic attributes for the new edit inventory quantity request
edit_inventory_quantity_request['materialIdOrPath'] = 'Bottle/Milk'
edit_inventory_quantity_request['sourceLocationIdOrPath'] = 'DairyCo'
edit_inventory_quantity_request['newQuantity'] = 610
# (You can continue setting other properties as needed here)

# Validate edit inventory quantity request parameters
validation_errors = system.mes.inventory.validateEditInventoryQuantityRequest(**edit_inventory_quantity_request)

if len(validation_errors) > 0:
print('Validation errors found:', validation_errors)
else:
print('Edit inventory quantity request parameters are valid.')