Skip to main content
View as Markdown

system.kanoa.item.checkItemState(itemStateName, itemStateClassId, itemStates, userId)

Checks if an item state exists in the passed itemStates dictionary and creates it if it doesn't

Parameters​

itemStateName String: Name of item state
itemStateClassId Integer: Item class Id
itemStates Dictionary
userId Integer: Id of user executing the function

Returns​

itemStateId Integer
itemStates Dictionary Updated dictionary if new item state created
itemStatesUpdated Boolean True if itemStateName was not found and added to itemStates
message String None if success

Example​

itemStateName = 'Illegible label'
itemStateClassId = 45
itemStates = system.kanoa.utilities.convertDatasetToDict(system.kanoa.item.getItemStates({}), 'itemStateName', 'itemStateId')
userId = 17
retVal, msg = system.kanoa.item.checkItemState(itemStateName, itemStateClassId, itemStates, userId)