system.kanoa.cmms.getProcedureStepChecks(paramsDict)

Retrieves procedure step check definitions - the individual checks configured for a step within a procedure template, as opposed to the check events generated when those checks are actually performed. Call this to populate a procedure editor screen showing which checks are required at each step, or to build a checklist UI before a work order is executed. Every key in paramsDict is optional, so passing an empty dictionary returns every configured check, while filter keys such as procedureId or procedureStepId narrow the result to a specific procedure or step.

---

Parameters

paramsDict Dictionary

- checkName	String
- enabled	Boolean
- procedureId	Integer
- procedureName	String
- procedureStepCheckId	Integer
- procedureStepId	Integer
- required	Boolean
- stepName	String

---

Returns

procedureStepCheckData pyDataset

---

Example

# Get all required checks configured for a specific procedure step
paramsDict = {"procedureStepId": 139, "required": True}
data = system.kanoa.utilities.convertDatasetToJSON(system.kanoa.cmms.getProcedureStepChecks(paramsDict))

for i, row in enumerate(data):
	print 'Row %i'%i
	for k,v in row.items():
		print k,v
	
	break
>>> 
Row 0
lastUpdatedBy jason on 2026-04-16 17:53:27.243
checkDescription Verify proper chain tension. Check slack against manufacturer spec. Adjust if needed.
createdByUser jason
checkName Verify Proper Chain Tension
procedureId 36
required False
enabled True
checkConfig {"engUnitId":"11","dataTypeId":"5","specInfo":{"specType":"tolerance","regex":{"value":""},"setPoint":{"value":null,"operator":null},"range":{"min":null,"max":null},"tolerance":{"tgt":null,"lel":null,"lsl":null,"lcl":null,"ldl":null,"udl":null,"uel":null,"usl":null,"ucl":null}},"pickListInfo":{"pickListValues":{"Number":{"min":null,"max":null,"increment":null},"Tree":"","Fraction":{"min":null,"max":null,"increment":null},"Text":{"PASS":[],"WARNING":[],"FAIL":[],"NEUTRAL":[],"multiSelect":false},"Time":null,"Barcode Scanner":{"script":null},"Boolean":{"enableNA":true,"TRUE":["OK"],"FALSE":["Not OK"]}},"pickListId":8}}
procedureStepCheckId 9
changedDate Thu Apr 16 17:53:27 UTC 2026
createdDate Sat Apr 11 16:28:34 UTC 2026
stepName Chain Tension
createdBy 5
changedBy 5
procedureName Loader Chain Drive
sortOrder 0
changedByUser jason
procedureStepId 139
>>>