Docs

BOM Line Items

A BOM line item represents a unique item on a BOM and the quantity required. Each line item references a specific type - a rack type, device type, module type, or cable type - along with an optional set of variant attributes which further distinguish it from other items of the same type.

Line items are typically created automatically when a BOM is generated from its scope rules, but may also be added manually. Manually-added line items are preserved across regenerations.

Line items may only be created or deleted while their parent BOM is in draft status. Auto-generated line items cannot be edited; to override one, delete it and add a manual line item in its place. The combination of BOM, item type, item ID, variant, and auto-generated flag must be unique.

Fields

BOM

The BOM to which this line item belongs.

Item Type

The content type of the referenced item. One of rack type, device type, module type, or cable type.

Item ID

The primary key of the referenced item within its type.

Variant

An optional JSON object of attributes that distinguish this line item from others of the same type. The tracked attributes depend on the item type:

Item TypeVariant Attributes
Rack type(none)
Device typeairflow
Module typeairflow
Cable typecolor, length, length_unit

Quantity

The number of items required. Must be at least 1.

Auto-Generated

Indicates that this line item was created by the BOM generation process. Auto-generated line items are deleted and recreated each time the BOM is regenerated; manually-created line items are not. Auto-generated line items are read-only - they cannot be edited. To override one, delete it and add a manual line item in its place. This field is set automatically.

On this page