‘required_inventories’ Structure

The 'required_inventories' structure is an array of 'required_inventory' structures that define inventories required for the activity performance.

If an 'update_activity' command contains a 'required_inventories' element, then:

• the existing required inventories of the activity are deleted

• new required inventories are added when specified in the request

• an empty 'required_inventories' element deletes all existing required inventories of the activity

The required inventory will not be added if:

• Command type is not 'update_activity'

• Activity status is not 'pending'

• Activity does not have the 'required inventory support' feature enabled

• Inventory Type specified in the request is invalid

• Model specified in the request does not match the model property rules

• Required Inventory with this type ID and Model already exists for this activity

In all of the above cases, a warning is returned in response and the rest of the command is executed without modifying the required inventory.

'required_inventories' structure elements

Name	Type	Description
type	string	Inventory type label
model	string	Inventory model. Valid values depend on the inventory type. 'model' is validated against the rules of the 'Model' property of 'Inventory Type'.
quantity	number	Number of inventories required for the activity.

• 'required_inventories' Structure Example

<required_inventories>   
	<required_inventory>      
		<type>CONNECTOR</type>      
		<model>CX1135</model>      
		<quantity>5</quantity>   
	</required_inventory>
</required_inventories>