system.kanoa.quality.sheet.addSheetVersionHistory

Requires kanoaQDS license

Description

Adds a new version history entry for a check sheet.

Syntax

addSheetVersionHistory(chkShtVersionInfo, userId)

Parameters:

– chkShtVersionInfo (dictionary): Version history details to insert.
– userId (int): User creating the version history entry.

Returns:

– chkShtVersionHistoryId (int): ID of the inserted version history row.
– msg (string or None): None if success; error details on failure.

Dictionary

Parameter	Type	Required	Notes
chkShtId	int	Yes	Check sheet ID
masterChkShtId	int	Yes	Master check sheet ID
chkShtVersionStateId	int	Yes	Target version state ID
chkShtVersionNumber	int	Yes	Version number to record
comment	string	No	Optional comment for the history entry

Code Examples

# Basic insert
info = {
  "chkShtId": 2002,
  "masterChkShtId": 1001,
  "chkShtVersionStateId": 2,   # e.g., Released
  "chkShtVersionNumber": 3,
  "comment": "Initial release"
}
vh_id, msg = system.kanoa.quality.sheet.addSheetVersionHistory(
  chkShtVersionInfo=info,
  userId=123
)
print(vh_id, msg)

# Insert without a comment
info = {
  "chkShtId": 2002,
  "masterChkShtId": 1001,
  "chkShtVersionStateId": 3,   # e.g., In Revision
  "chkShtVersionNumber": 4,
  "comment": None
}
vh_id, msg = system.kanoa.quality.sheet.addSheetVersionHistory(info, 123)
print(vh_id, msg)