Previous Topic: GetUnitInventoryItemsNext Topic: OpenUnitInventoryComponentList


OpenUnitInventoryComponentGroupList

The OpenUnitInventoryComponentGroupList method opens a list of inventory component groups on a given unit.

Parameters

xsd:string sessionId (m)

The session identifier.

xsd:string unitId (m)

The UUID of the unit whose inventory component groups are to be listed.

UnitInventoryComponentProperties unitInventoryComponentProperties (m)

The properties of the UnitInventoryComponent whose groups should be listed.

UnitInventoryGroupPropertiesRequired unitInventoryGroupPropertiesRequired (m)

The properties that will be required when getting a group from the list.

Return Values

xsd:long OpenListHandle

A numeric handle to a list of inventory component groups that can be passed to GetUnitInventoryComponentGroups

xsd:long totalNoOfUnitInventoryComponentGroups

The total number of inventory component groups in the list whose handle has been returned.

Remarks

The method returns the size of the list, and a handle to the list that you can use with the GetUnitInventoryComponentGroups method.

Asset Inventory is reported in a tree like structure. The root of this tree is called the inventory component, any groups under this root are called inventory component groups, and the subgroups in each component group are called inventory groups. The elements under inventory groups are called inventory items, as follows:

"General Inventory" [Inventory Component]

"System" [Inventory Component Group]

"Processors" [Inventory Group]

"Speed" = "slow" [Inventory Item]

More information:

UnitInventoryComponentProperties

UnitInventoryGroupPropertiesRequired