MES Stateless API

GetAll Method (BomItem)

Save PDF

GetAll Method (BomItem)

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetAll() method retrieves one or more BOM item records from the Bom_Item table, as specified by the filter parameters. Passing no filter parameters will retrieve all BOM item records from the table.

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal parentItemId As String, _
   ByVal verId As String, _
   ByVal bomPos As Nullable(Of Integer), _
   ByVal itemId As String, _
   ByVal reqdGradeCd As Nullable(Of Integer), _
   ByVal updateInv As Nullable(Of Boolean), _
   ByVal backflush As Nullable(Of Boolean), _
   ByVal defReasCd As Nullable(Of Integer), _
   ByVal defStorageEntId As Nullable(Of Integer), _
   ByVal defRejectEntId As Nullable(Of Integer), _
   ByVal serialNoSource As Nullable(Of Boolean), _
   ByVal spare1 As String, _
   ByVal spare2 As String, _
   ByVal spare3 As String, _
   ByVal spare4 As String, _
   ByVal lastEditBy As String, _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim parentItemId As String
Dim verId As String
Dim bomPos As Nullable(Of Integer)
Dim itemId As String
Dim reqdGradeCd As Nullable(Of Integer)
Dim updateInv As Nullable(Of Boolean)
Dim backflush As Nullable(Of Boolean)
Dim defReasCd As Nullable(Of Integer)
Dim defStorageEntId As Nullable(Of Integer)
Dim defRejectEntId As Nullable(Of Integer)
Dim serialNoSource As Nullable(Of Boolean)
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = BomItem.GetAll(parentItemId, verId, bomPos, itemId, reqdGradeCd, updateInv, backflush, defReasCd, defStorageEntId, defRejectEntId, serialNoSource, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   string parentItemId,
   string verId,
   Nullable<int> bomPos,
   string itemId,
   Nullable<int> reqdGradeCd,
   Nullable<bool> updateInv,
   Nullable<bool> backflush,
   Nullable<int> defReasCd,
   Nullable<int> defStorageEntId,
   Nullable<int> defRejectEntId,
   Nullable<bool> serialNoSource,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

parentItemId

Optional filter parameter. Holds the ID of a parent item.

verId

Optional filter parameter. Holds the ID of a BOM version.

bomPos

Optional filter parameter. Holds a BOM position. For by-products, this value is negative. For produced items, the BOM position is 0, and the item_id is the same as the parent_item_id. The BOM position is usually in a sequence.

itemId

Optional filter parameter. Holds the ID of an item being produced or consumed.

reqdGradeCd

Optional. Holds the required grade code for the BOM item. If null, an item of any grade code can be consumed.

updateInv

Optional filter parameter. Holds a flag that specifies whether the inventory table is updated with the consumed items.

backflush

Optional filter parameter. Holds a flag that specifies whether consumption is backflushed.

defReasCd

Optional filter parameter. Holds the default consumption or production code for an item. If null, it defaults to the value specified for the entity that runs the job.

defStorageEntId

Optional filter parameter. Holds the default storage entity ID for a product or by-product. If null, it defaults to the entity that runs the job.

defRejectEntId

Optional filter parameter. Holds the ID of the default storage entity for the rejected production items. If null, the def_storage_ent_id is used.

serialNoSource

Optional filter parameter. Holds a flag that specifies whether a produced item inherits its serial numbers from this component. The default is false.

spare1

Optional filter parameter. Holds the contents of the user-defined spare1 field.

spare2

Optional filter parameter. Holds the contents of the user-defined spare2 field.

spare3

Optional filter parameter. Holds the contents of the user-defined spare3 field.

spare4

Optional filter parameter. Holds the contents of the user-defined spare4 field.

lastEditBy

Optional filter parameter. Holds the ID of a user who added or last updated a BOM item record.

lastEditAt

Optional filter parameter. Holds the date/time when a BOM record was added or last updated.

Return Value

Returns a DataSet that contains all the records in the Bom_Item table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
parent_item_id	A string that is the ID of the item being made.
ver_id	A string that is the BOM version.
bom_pos	An integer that is the BOM position. For by-products, this value is negative. For produced items, the BOM position is 0, and the item_id is the same as the parent_item_id. The BOM position is usually in a sequence.
parent_item_desc	A string that is the description of a parent item.
item_id	A string that is the ID of the item being produced or consumed.
item_desc	A string that is the description of an item.
reqd_grade_cd	An integer that is the required grade code for a BOM Item. If null, the required grade code is disabled.
item_grade_desc	A string that is the item grade description.
instruction	A string that contains instructions on how to consume or produce this item.
qty_per_parent_item	A floating point number that is the nominal quantity of the item required per unit of the current parent item.
max_qty_per_parent_item	A floating point number that is the maximum acceptable quantity of this BOM component.
min_qty_per_parent_item	A floating point number that is the minimum acceptable quantity of this BOM component.
update_inv	A Boolean that is a flag that specifies whether the inventory table is updated with the consumed items.
backflush	A Boolean that is a flag that specifies whether consumption is backflushed.
def_reas_cd	An integer that is the default consumption or production code for an item. If null, it defaults to the value specified for the entity that runs the job.
reas_desc	A string that is the description of the default reason code.
def_lot_no	A string that is the default lot number for an item. If null, it defaults to the lot number specified for the entity that runs the job.
def_sublot_no	A string that is the default sublot number for an item. If null, it defaults to the sublot number specified for the entity that runs the job.
def_storage_ent_id	An integer that is the ID of the default storage entity for a product or by-product. If null, it defaults to the default storage entity for the entity that runs the job.
def_reject_ent_id	An integer that is the default storage entity for the rejected production items. If null, the def_storage_ent_id is used.
must_consume_from_inv	A Boolean that is a flag that specifies whether consumption must occur from the inventory for this item.
may_choose_alt_inv_loc	A Boolean that is a flag that specifies whether a user can select alternate inventory locations when consuming or producing this item.
may_create_new_lots	A Boolean that is a flag that specifies whether a user can create new lots when consuming or producing this item.
must_consume_from_wip	A Boolean that is a flag that specifies whether the lots consumed during a job can be limited to those lots produced to the Item_Inv table for the same work order in an upstream job.
must_consume_before_prod	A Boolean that is a flag that specifies whether to prevent any production transactions until 'acceptable' quantities of BOM components have been consumed, as specified by the 'max_qty_per_parent_item' and 'min_qty_per_parent_item' fields.
ent_name	A string that is the name of a storage entity.
scaling_factor	A floating point number that is the scaling factor, which is used to retrieve the correct units from counts if the counts are item-dependent.
constant_qty	A Boolean that is a flag that specifies whether the quantity of this consumed item is independent of the quantity of the parent item produced.
est_time	A floating point number that is the number of hours to consume or produce the component per unit of BOM position zero.
serial_no_source	A Boolean that is a flag that specifies whether the produced item can inherit its serial numbers from this component. The default is false.
spare1	A string that is the contents of the user-defined spare1 field.
spare2	A string that is the contents of the user-defined spare2 field.
spare3	A string that is the contents of the user-defined spare3 field.
spare4	A string that is the contents of the user-defined spare4 field.
uom_id	An integer that contains the ID of the unit of measure for the item.
uom_description	A string that is the description of the unit of measure for the item.
num_decimals	An integer that contains the number of decimal places used for quantity values of the item.
last_edit_comment	A string that contains comments about why the record was updated.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A date/time that indicates when the record was added or last updated.
mod_id	The current modification ID of the record in the table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes.

MES Stateless API