system.mes.inventory.validateSplitRequest

Validates the specified parameters for a split request and returns any validation errors. This only checks if the split request can be processed based on the attributes given, without actually performing the inventory splitting. Use this function to verify your parameters before executing the actual split operation.

Syntax

system.mes.inventory.validateSplitRequest(**split_request)

Parameters

Parameter	Type	Nullable	Description
type	String	True	The type of request defined by the LotRecordType Enum. It is internally set and must not be modified, as changes may break functionality.
quantity	Double	False	The quantity to split from the location.
unitOfMeasureSymbol	String	True	The symbol of the unit of measure for the quantity.
sourceLotId	String (ULID)	False	The ID of the inventory lot being split.
sourceLocationIdOrPath	String	False	The ID or path of the location from which inventory will be split.
destinationLotName	String	False	The name of the inventory lot the split inventory goes to.
operationId	String (ULID)	True	The ID of the operation splitting this inventory.
inventoryOperationId	String (ULID)	True	The ID of the inventory operation related to this split action.
productionOrderIdOrName	String	True	The ID or name of the production order associated with the split.
materialReasonCodeId	String (ULID)	True	The ID of the material reason code to add additional context.
destinationInventoryName	String	True	The name of the inventory the split inventory goes to.
notes	String	True	Notes related to the split request.
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 object where keys are field names and values are lists of validation violation messages.

Code Examples

# Generate the object structure for a new split request object with no initial arguments
split_request = system.mes.inventory.newSplitRequest()

# Set basic attributes for the new split request
split_request['sourceLocationIdOrPath'] = 'DairyCo'
split_request['sourceLotId'] = '01JJCQEJYG-E31FHVTF-JB6WEJTC'
split_request['destinationLotName'] = '5db685a7-2096-449a-b96c-effb3739e021'
split_request['quantity'] = 610
# (You can continue setting other properties as needed here)

# Validate split request parameters
validation_errors = system.mes.inventory.validateSplitRequest(**split_request)

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