MES Stateless API

GetJobBomSubsts Method

Save PDF

GetJobBomSubsts Method

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetJobBomSubsts() method retrieves the job BOM data and its substitutes for the specified job or optionally, the BOM position, from the Job_Bom table.

Syntax

'Declaration
 
Public Shared Function GetJobBomSubsts( _
   ByVal userId As String, _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Integer, _
   ByVal bomPos As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim userId As String
Dim woId As String
Dim operId As String
Dim seqNo As Integer
Dim bomPos As Nullable(Of Integer)
Dim value As DataSet
 
value = JobBom.GetJobBomSubsts(userId, woId, operId, seqNo, bomPos)

public static DataSet GetJobBomSubsts( 
   string userId,
   string woId,
   string operId,
   int seqNo,
   Nullable<int> bomPos
)

Parameters

userId: Required. Holds the ID of the user to obtain the required privileges.
woId: Required. Holds the ID of the work order for the job.
operId: Required. Holds the ID of the operation for the job.
seqNo: Required. Holds the operation sequence number of the job.
bomPos: Optional. Holds the BOM position.

Return Value

Returns a DataSet that contains all the records in the Job_Bom 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
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.
substitute_item	A Boolean that is a flag that indicates whether the item is a substitute.
current_subst	An integer that is the alt_no of the currently used substitute from the Job_BOM_Subst table. The default is null.
alt_no	An integer that indicates the alternative from the Job_Bom_Subst table for the given BOM position if the substitute_item parameter is set to 1.
pref	An integer that indicates the preference of the substitute from the Job_Bom_Substitute table. The lower numbered alternatives are preferable than the higher numbered ones.
subst_level	An integer that is the substitution level of the user to use the substitute from the Job_Bom_Substitute table.
item_id	A string that is the ID of the item.
item_desc	A string that is the description of the item.
uom_id	An integer that is the ID of the item’s units of measure.
description	A string that is the description of the units of measure.
abbreviation	A string that is the abbreviation of the units of measure that is appended to quantities.
lifetime	An integer that indicates the number of days left before the item expires. It never expires if the value is null.
serial_no_level	An integer: if set to 0, indicates that the lot number has the serial number for the item in the Item table. if set to greater than 0, indicates that the sublot number has the serial number for the item in the Item table. if set to less than 0, indicates that there are no serial numbers for the item in the Item table.
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 from 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 itemA string containing 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 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 specifies whether the required start value is a percentage or an absolute quantity.
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 specifies the default consumption or production code of 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 from 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 product.
ent_name	A string that is the default storage entity (def_storage_ent_id) from 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 the 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.
consumed_so_far	A floating point number that is the quantity of the item consumed up to the current date.
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 it should take to consume or produce the component per unit of BOM position zero. If null, the BOM position is zero.
serial_no_source	A Boolean that is a flag that indicates whether the produced item can inherit its serial numbers from the component if the substitute_item parameter is set to 0.
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.
item_spare1	A string that is the contents of the user-defined spare1 field from the Item table.
item_spare2	A string that is the contents of the user-defined spare2 field from the Item table.
item_spare3	A string that is the contents of the user-defined spare3 field from the Item table.
item_spare4	A string that is the contents of the user-defined spare4 field from 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.The date and time when this record was created or last modified.
qty_used_in_steps	A floating point number that is the sum of all the qty_per_parent_item parameters in the Job_Bom_Step table for the job for which the BOM position is not zero.
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

GetJobBomSubsts Method

Table of Contents

GetJobBomSubsts Method

In This Topic

MES Stateless API

GetJobBomSubsts Method

Syntax

Parameters

Return Value

See Also

Reference

In This Topic