system.kanoa.asset.getAssetStates

Requires kanoaOPS license

Description

Gets asset states.

Syntax

getAssetStates(paramsDict)

Parameters:

paramsDict (dict): A dictionary containing optional parameters for filtering:

Returns:

pyDataset: A dataset containing asset state information.

Dictionary

Parameter	Type	Required	Notes
stateAssetLinkId	int		Filter by state asset link ID.
enabled	bool		Filter by enabled status.
assetPath	str		Filter by asset path.
assetTypeName	str		Filter by asset type name.
assetId	int		Filter by asset ID.
assetIdList	list of str		Filter by a list of asset IDs.
stateId	int		Filter by state ID.
stateName	str		Filter by state name.
stateCode	str		Filter by state code.
stateTypeName	str		Filter by state type name.
stateCategoryId	int		Filter by state category ID.
stateCategoryName	str		Filter by state category name.

Code Examples

# Example Usage:
state_params = {
    'enabled': True,
    'assetPath': 'Kanoa Industries%',
    'assetId': 1,
    'assetTypeName': 'site',
    'stateId': 1,
    'stateName': 'Running',
    'stateTypeName': 'Running'
}
asset_states = system.kanoa.asset.getAssetStates(state_params)