MES Stateless API

GetAll Method (JobBomSubstitute)

Save PDF

GetAll Method (JobBomSubstitute)

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetAll() method retrieves one or more job BOM substitute records from the Job_Bom_Subst table, as specified by the filter parameters. Passing no filter parameters will retrieve all job BOM substitute 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 altNo As Nullable(Of Integer), _
   ByVal pref As Nullable(Of Integer), _
   ByVal substLevel 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 defLotNo As String, _
   ByVal defStorageEntId As Nullable(Of Integer), _
   ByVal defRejectEntId 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 altNo As Nullable(Of Integer)
Dim pref As Nullable(Of Integer)
Dim substLevel 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 defLotNo As String
Dim defStorageEntId As Nullable(Of Integer)
Dim defRejectEntId 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 = JobBomSubstitute.GetAll(woId, operId, seqNo, bomPos, altNo, pref, substLevel, itemId, reqdGradeCd, updateInv, backflush, defReasCd, defLotNo, defStorageEntId, defRejectEntId, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   string woId,
   string operId,
   Nullable<int> seqNo,
   Nullable<int> bomPos,
   Nullable<int> altNo,
   Nullable<int> pref,
   Nullable<int> substLevel,
   string itemId,
   Nullable<int> reqdGradeCd,
   Nullable<bool> updateInv,
   Nullable<bool> backflush,
   Nullable<int> defReasCd,
   string defLotNo,
   Nullable<int> defStorageEntId,
   Nullable<int> defRejectEntId,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

woId: Optional filter parameter. Holds the session ID and thus the user who is making this method call.
operId: Optional filter parameter. Holds the ID of the operation for a job.
seqNo: Optional filter parameter. Holds the operation sequence number of the job.
bomPos: Optional filter parameter. Holds the BOM position.
altNo: Optional filter parameter. Holds the alternative from the Job_Bom_Subst table for a given BOM position.
pref: Optional filter parameter. Holds the preference of the substitute.
substLevel: Required. Holds an integer that acts as a substitution privilege level, so that a user has to have this substituion level to be able to substitute the BOM item. The default is 0, which means anyone can use this substitute.
itemId: Optional filter parameter. Holds the ID of the substitute item being produced or consumed.
reqdGradeCd: Optional filter parameter. Holds the required grade code for a BOM item.
updateInv: Optional filter parameter. Holds a flag that specifies whether the inventory table must be updated with consumed items.
backflush: Optional filter parameter. Holds a flag that specifies that consumption is backflushed.
defReasCd: Optional filter parameter. Holds the ID of the default item reason code.
defLotNo: Optional filter parameter. Holds the default lot number of an item.
defStorageEntId: Optional filter parameter. Holds the ID of the default storage entity for an item.
defRejectEntId: Optional filter parameter. Holds the ID of the default storage entity for the rejected production items.
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 substitute record.
lastEditAt: Optional filter parameter. Holds the date/time when a job BOM substitute record was added or last updated.

Return Value

Returns a DataSet that contains records for all the job BOM substitutes that satisfy the specified filters. The returned records include columns from the Item, Update_Inventory, and Item_Inv tables. If no matching job BOM substitutes are found, an empty DataSet is returned.

A dataset is returned which contains a row for each job_bom_subst record that fits within the filtered dataset. If no records are found for the specified parameters, an empty dataset will be returned. Any exceptions thrown by the middleware will need to be handled by the client calling this method.

Column Name	Description
wo_id	A string that is the ID of the work order for a job.
oper_id	A string that is the ID of the operation for a job.
seq_no	An integer that is the sequence number for a job.
bom_pos	An integer that is the BOM position.
alt_no	An integer that is the alternative for the given BOM position.
pref	An integer that is the preference of the substitute from the Job_Bom_Substitute table.
subst_level	An integer that is the substitution level of the user to use this substitute.
item_id	A string that is the ID of the item.
item_desc	A string that is the description of the item, which is returned from the Item table that is linked to the item_id.
reqd_grade_cd	An integer that is the required grade code for the BOM Item. If null, the required grade code is disabled.
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 a 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 a job.
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_storage_ent_name	A string that is the name of a default storage entity.
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.
reject_ent_name	A string that is the name of a reject entity.
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 minQtyPerParentItem parameters.
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.
spare1	A string that is the contents of the user-defined spare1 field.
spare1	A string that is the contents of the user-defined spare2 field.
spare1	A string that is the contents of the user-defined spare3 field.
spare1	A string that is the contents of the user-defined spare4 field.
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.
uom_id	An integer that is the ID of the UOM.
num_decimals	An integer that is the number of decimal places to use when specifying a quantity of the item.
row_id	An integer that is the ID of the job BOM substitute row in the table.

MES Stateless API