system.kanoa.quality.sheet.updateSheetField

Requires kanoaQDS license

Description

Updates a single field on an existing check sheet.

Syntax

updateSheetField(chkShtId, field, value, userId)

Parameters:

chkShtId (int): Check sheet ID.

field (string): Column name to update.

value (pyObject): New value for the column.

userId (int): User ID performing the update.

Returns:

recordsModified (int): Number of records modified.

message (string | None): None if success; error details on failure.

Parameters

Parameter	Type	Required	Notes
chkShtId	int	Yes	ID of the check sheet to update
field	string	Yes	Must be a valid column in qds.chkSht
value	pyObject	Yes	Bound as a query parameter; type should match the target column
userId	int	Yes	Recorded in changedBy; changedDate set to current time

Code Examples

# Update the 'enabled' flag to True
records_modified, msg = system.kanoa.quality.sheet.updateSheetField(
    chkShtId=56,
    field='enabled',
    value=True,
    userId=123
)

print(records_modified, msg)  # e.g., 1, None

# Update the 'description'
records_modified, msg = system.kanoa.quality.sheet.updateSheetField(
    chkShtId=56,
    field='description',
    value='Periodic safety checklist for Line A',
    userId=123
)
print(records_modified, msg)