BOM Objects

Public Preview: Asset Lifecycle is in public preview. The functionality and API surface may evolve in future releases.

A BOM object is a junction between a BOM and an individual NetBox object (a rack, device, module, or cable) gathered by the BOM's scope rules. The set of BOM objects is a point-in-time snapshot of the BOM's scope: it is cleared and rebuilt each time the BOM is regenerated.

BOM objects are also used to track installation. Once equipment has been received, each BOM object may be linked to the shipment that delivered the item it represents, or to the spare item pulled from inventory to fulfill it.

Fields

BOM

The BOM which includes this object in its scope.

Assigned Object Type

The content type of the referenced NetBox object. One of dcim.rack, dcim.device, dcim.module, or dcim.cable.

Assigned Object ID

The primary key of the referenced object within its type.

Shipment

The shipment that delivered the equipment installed as this object. Optional. Mutually informative with Spare Item - only one is set for any given installed object.

Spare Item

The spare item used to fulfill this object from existing inventory. Optional.