Skip to main content

system.kanoa.lot.getRoutes

Requires kanoaOPS license

Description

Returns route records filtered by the provided parameters.

Syntax

getRoutes(paramsDict)

Parameters:

– paramsDict (dictionary): Dictionary of filters for the query.

Returns:

– routeData (pyDataset): Result set of routes matching the filters.

Dictionary

ParameterTypeRequiredNotes
routeIdintNoFilter by route ID
routeNamestringNoFilter by route name (supports LIKE search)
itemIdintNoFilter by item ID associated with the route
itemPathstringNoFilter by item path (supports LIKE search)
itemClassIdintNoFilter by item class ID
itemClassPathstringNoFilter by item class path (supports LIKE search)
enabledboolNoFilter by enabled state

Code Examples

# Get all enabled routes
paramsDict = {"enabled": True}
routeData = system.kanoa.lot.getRoutes(paramsDict=paramsDict)

# Get routes by item ID
paramsDict = {"itemId": 1205}
routeData = system.kanoa.lot.getRoutes(paramsDict=paramsDict)

# Get routes by route name (LIKE search)
paramsDict = {"routeName": "%Assembly%"}
routeData = system.kanoa.lot.getRoutes(paramsDict=paramsDict)

# Get routes by item class path
paramsDict = {"itemClassPath": "%/Products/Widgets/%"}
routeData = system.kanoa.lot.getRoutes(paramsDict=paramsDict)

# Get a specific route by ID
paramsDict = {"routeId": 9}
routeData = system.kanoa.lot.getRoutes(paramsDict=paramsDict)