Skip to main content

system.kanoa.quality.sheet.updateSheetType

Description

Updates the sheetType associated with a check sheet. Think of a sheet type essentially as a folder where checks sheets of different types can be stored. Initially implemented as a type field, it has now become the parentId of the check sheet allowing types to be nested.

Syntax

updateSheetType(shtTypeInfo, userId)

Parameters:
  • shtTypeInfo (dictionary): Dictionary containing sheet type information.
  • userId (int): User ID.

  • Returns:
  • chkShtTypeId (int): ID of the updated sheet type.
  • Dictionary

    ParameterTypeRequiredNotes
    chkShtTypeIdintID of the sheet type to update
    chkShtTypeNamestringName of the sheet type
    parentIdintID of the parent sheet type
    descriptionstringDescription of the sheet type (optional)
    enabledboolTrue to enable the sheet type

    Code Examples

    # Usage example
    sht_type_info = {'chkShtTypeId': 4, 'chkShtTypeName': 'Quality', 'parentId': 1, 'description': None, 'enabled': True}
    user_id = 123
    chk_sht_type_id = system.kanoa.quality.sheet.updateSheetType(shtTypeInfo=sht_type_info, userId=user_id)

    print(chk_sht_type_id)