system.mes.inventory.validateScrapAllRequest

Validates a scrap all request based on the provided parameters, checking if the request meets all the requirements to be executed successfully. This only checks if the request can be performed based on the attributes given.

Syntax

system.mes.inventory.validateScrapAllRequest(**scrap_all_request)

Parameters

Parameter	Type	Nullable	Description
type	String	True	The type of request defined by the LotRecordType Enum. It is internally set to SCRAP and must not be modified.
sourceLocationIdOrPath	String	False	The ID or path of the location from which inventory will be scrapped. Required.
materialIdOrPath	String	True	The ID or path of the material being scrapped. Optional - if omitted, all materials at the location will be scrapped.
operationId	String (ULID)	True	The ID of the operation scrapping this inventory.
inventoryOperationId	String (ULID)	True	The ID of the inventory operation related to this scrap action.
productionOrderIdOrName	String	True	The ID or name of the production order associated with the scrap.
materialReasonCodeId	String (ULID)	True	The ID of the material reason code to add additional context.
startDate	Instant	False	The start date and time of the scrap. Default value is Current Instant.
endDate	Instant	True	The end date and time of the scrap.
notes	String	True	Notes related to the scrap all 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. If the object is empty, there are no validation errors.

Code Examples

# Generate the object structure for a new scrap all request
new_request = system.mes.inventory.newScrapAllRequest()

# Set basic attributes for the new scrap all request
new_request['materialIdOrPath'] = 'Bottle/Milk'
new_request['sourceLocationIdOrPath'] = 'DairyCo'

# Validate the request before execution
validation_result = system.mes.inventory.validateScrapAllRequest(**new_request)

# Check if there are any validation errors
if len(validation_result) > 0:
    print('Validation errors found:', validation_result)
else:
    print("Request is valid, proceeding with scrap all operation")