MES Stateless API

GetAll Method (JobBom)

Save PDF

GetAll Method (JobBom)

Save PDF

Last UpdatedNov 06, 2025
7 minute read

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

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Nullable(Of Integer), _
   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 currentSubst As Nullable(Of Integer), _
   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 woId As String
Dim operId As String
Dim seqNo As Nullable(Of Integer)
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 currentSubst As Nullable(Of Integer)
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 = JobBom.GetAll(woId, operId, seqNo, bomPos, itemId, reqdGradeCd, updateInv, backflush, defReasCd, defStorageEntId, defRejectEntId, serialNoSource, currentSubst, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   string woId,
   string operId,
   Nullable<int> seqNo,
   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,
   Nullable<int> currentSubst,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

woId: Optional filter parameter. Holds the ID of the work order for a job.
operId: Optional filter parameter. Holds the ID of the operation for a job.
seqNo: Optional filter parameters. Holds the operation sequence number of a job.
bomPos: Optional filter parameter. Holds the BOM position.
itemId: Optional filter parameter. Holds the ID of an item being produced or consumed.
reqdGradeCd: Optional filter parameter. Holds the required grade code for a BOM item. If null, the required grade code is disabled.
updateInv: Optional filter parameter. Holds a flag that specifies that the inventory table is updated with consumed items.
backflush: Optional filter parameter. Holds a flag that specifies that consumption is backflushed.
defReasCd: Optional filter parameter. Holds the default consumption or production code of an item. If null, it defaults to the value specified for the entity that runs the job.
defStorageEntId: Optional filter parameter. Holds the ID of the default storage entity for an item or a by-product.
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 the produced item must inherit its serial numbers from this component. The default is false.
currentSubst: Optional filter parameter. Holds the alt_no of the currently used substitute from the Job_Bom_Subst table. The default is null.
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 the user who added or last updated a job BOM record.
lastEditAt: Optional filter parameter. Holds the date/time when a job BOM record was added or last changed.

Return Value

Returns a DataSet that contains records for all the job BOM items that satisfy the specified filters. The returned records include columns from the Job_Bom, Job_Step, and Job_Bom_Step tables. If no matching job BOM records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

ColumnName	Description
wo_id	A string that is the ID of the work order for the job.
oper_id	A string that is the ID of the operation for the job.
seq_no	An integer that is the sequence number for the job.
bom_pos	An integer that is the BOM position.
item_id	A string that is the ID of the item.
item_desc	A string that is the description of the item.
reqd_grade_cd	An integer that is the required grade code for the BOM Item. If null, the required grade code is disabled.
item_grade_desc	A string that is the item grade description of the Item_Grade table.
color	An integer that is the RGB background color associated with the required grade of the Item_Grade table.
instruction	A string that contains the instructions on is 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 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.
reqd_start_val	A floating point number that is the amount of the component required before running the job.
reqd_start_val_is_pct	A Boolean that is a flag that indicates whether the required start value is a percentage or absolute quantity.
update_inv	A Boolean that is a flag that specifies whether the inventory table is updated with consumed items.
backflush	A Boolean that is a flag that specifies whether the consumption is backflushed.
def_reas_cd	An integer that is the default consumption or production code of the 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 of the Item_Reas table.
def_lot_no	A string that is the default lot number for the item.
def_sublot_no	A string that is the default sublot number for the item.
def_storage_ent_id	An integer that is the ID of the default storage entity for the item or the by-product.
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.
ent_name	A string that is the default storage entity (def_storage_ent_id) of the Ent table.
scaling_factor	A floating point number that is the scaling factor to get the correct units from counts if the counts are item dependent.
must_consume_from_inv	A Boolean that is a flag that specifies whether consumption must occur from inventory for this item.
may_choose_alt_inv_loc	A Boolean that is a flag that specifies whether the 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 the 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 are limited to the 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 the production transactions are prevented until acceptable quantities of BOM components are consumed, as specified in the maxQtyPerParentItem and minQtyPerParentItemparameters.
consumed_so_far	A floating point number that is the quantity of the item consumed.
constant_qty	A Boolean that is a flag that specifies whether the quantity of the consumed item is independent of the quantity of the parent item that is produced.
est_time	A floating point number that indicates the number of hours to consume or produce the component per unit of BOM position zero.
current_subst	An integer that is the alt_no of the currently used substitute of the Job_BOM_Subst table. The default is null.
job_bom_qty_reqd	A floating point number that indicates the amount required for outputs for the disassembly parameter.
serial_no_source	A Boolean that is a flag that specifies if the produced item is to inherit its serial numbers from this component.
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.
qty_reqd	A floating point number that is the quantity required for the job from the Job table.
qty_at_start	A floating point number that is the starting quantity for the job from the Job table.
num_decimals	An integer that is the number of decimal places used for quantity values of the item in the Item table.
last_edit_comment	A string that contains comments about why the record was added or 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.
qty_used_in_steps	A floating point number that is the quantity of items per unit of the parent item required for this job at this BOM position. Returns 0 for BOM position 0 (the production item).
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