The response body is of type object.

Returns a JSON array that includes the information about the matching job BOMs. If no matching job BOMs are found, an empty JSON array is returned.

The following properties are returned.

wo_id (string)

The ID of the work order for the job.

oper_id (string)

The ID of the operation for the job.

seq_no (integer)

The sequence number for the job.

bom_pos (integer)

The BOM position.

job_bom_subst_exist (Boolean)

Indicates whether substitutes exist for the BOM item.

current_subst (integer)

The alt_no of the currently used item substitute. The default is null.

pref (integer)

Indicates the preference of the substitute. The lower-numbered alternatives are preferable to the higher-numbered ones.

subst_level (integer)

The substitution level a user must have to be able to use the substitute item. The default is 0 (any user can use the substitute item).

item_id (string)

The ID of the item.

item_desc (string)

The description of the item.

item_display (integer)

The value that indicates what format to use when identifying the item in the user interface. The format values are defined in the system attribute Item display (attr_id 210 in the System_Attr table).

Possible values and their formats are:

0 = item_id

1 = item_desc

2 = item_id (item_desc)

3 = item_desc(item_id)

uom_id (integer)

The ID of the item unit of measurement (UOM).

description (string)

The description of the UOM.

abbreviation (string)

The abbreviation for the UOM.

lifetime (integer)

The number of days left before the item expires. If null, the item never expires.

reqd_grade_cd (integer)

The required grade code for the BOM Item. If null, the required grade code is disabled.

item_grade_desc (string)

The item grade description.

color (string)

The name or hex value of the HTML color that is the background color in the user interface that is associated with the required grade.

instruction (string)

Instructions about how to consume or produce this item.

qty_per_parent_item (double)

The nominal quantity of the item required per unit of the parent item.

max_qty_per_parent_item (double)

The maximum acceptable quantity of this BOM component.

min_qty_per_parent_item (double)

The minimum acceptable quantity of this BOM component.

reqd_start_val (double)

The amount of the component required before running the job.

reqd_start_val_is_pct (Boolean)

Indicates whether the required start value is a percentage or absolute quantity.

qty_prod (double)

The quantity of the item produced up to the current date and time.

qty_rejected (double)

The quantity of the item rejected up to the current date and time.

update_inv (Boolean)

Indicates whether the inventory table is updated with consumed items.

backflush (Boolean)

Indicates whether the consumption is backflushed.

def_reas_cd (integer)

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 (string)

The description of the default reason code.

def_lot_no (string)

The default lot number for the item.

def_sublot_no (string)

The default sublot number for the item.

def_storage_ent_id (integer)

The ID of the default storage entity for the item or the by-product.

ent_name (string)

The default storage entity (def_storage_ent_id).

scaling_factor (double)

The scaling factor to use to obtain the correct units from counts if the counts are item-dependent.

must_consume_from_inv (Boolean)

Indicates whether consumption must occur from inventory for this item.

may_choose_alt_inv_loc (Boolean)

Indicates whether the user can select alternate inventory locations when consuming or producing this item.

may_create_new_lots (Boolean)

Indicates whether the user can create new lots when consuming or producing this item.

must_consume_from_wip (Boolean)

Indicates 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 (Boolean)

Indicates whether the production transactions are prevented until acceptable quantities of BOM components are consumed, as specified in the max_qty_per_ parent_item and min_qty_per_ parent_item parameters of the BOM item.

consumed_so_far (double)

The quantity of the item consumed.

constant_qty (Boolean)

Indicates whether the quantity of the consumed item is independent of the quantity of the parent item that is produced.

est_time (double)

The number of hours to consume or produce the component per unit of BOM position 0.

spare1 (string)

The contents of the spare1 field.

spare2 (string)

The contents of the spare2 field.

spare3 (string)

The contents of the spare3 field.

spare4 (string)

The contents of the spare4 field.

qty_reqd (double)

The quantity required for the job.

qty_at_start (double)

The starting quantity for the job.

num_decimals (integer)

The number of decimal places used for quantity values of the item.

item_spare1 (string)

The contents of the item_spare1 field.

item_spare2 (string)

The contents of the item_spare2 field.

item_spare3 (string)

The contents of the item_spare3 field.

item_spare4 (string)

The contents of the item_spare4 field.

last_edit_comment (string)

Comments about why the record was added or updated.

last_edit_by (string)

The ID of the user who added or last updated the record.

last_edit_at (datetime)

The date and time when the record was added or last updated.

qty_used_in_steps (double)

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 (timestamp)

A binary number that increments each time the row is modified.

actual_qty (double)

The calculated quantity for the Job_Bom record.

If the Job_Bom record is for a consumed item and the consumption quantities of the consumed item do not depend on the number of produced parent items (that is, the BOM item is configured as "constant quantity"), then this quantity will be equal to the quantity per parent item.

For all other records, it will be one of the following, whichever value is greater:

• The start quantity multiplied by the quantity per parent item.
• The sum of the produced quantity plus the rejected quantity multiplied by the quantity per parent item.

actual_min_qty (double)

The calculated minimum quantity for the Job_Bom record.

If the Job_Bom record is for a consumed item and the consumption quantities of the consumed item do not depend on the number of produced parent items (that is, the BOM item is configured as "constant quantity"), then this quantity will be equal to the minimum quantity per parent item.

For all other records, it will be one of the following, whichever value is greater:

• The start quantity multiplied by the minimum quantity per parent item.
• The sum of the produced quantity plus the rejected quantity multiplied by the minimum quantity per parent item.

actual_max_qty (double)

The calculated maximum quantity for the Job_Bom record.

If the Job_Bom record is for a consumed item and the consumption quantities of the consumed item do not depend on the number of produced parent items (that is, the BOM item is configured as "constant quantity"), then this quantity will be equal to the maximum quantity per parent item.

For all other records, it will be one of the following, whichever value is greater:

• The start quantity multiplied by the maximum quantity per parent item.
• The sum of the produced quantity plus the rejected quantity multiplied by the maximum quantity per parent item.

qty_good_at_bom_pos (double)

The produced quantity of the BOM position item.

qty_rejected_at_bom_pos (double)

The rejected quantity of the BOM position item.

To get the BOM data for the job identified by work order WO20171213.2445, operation Roast, and sequence number 3:

api/JobBom?woId=WO20171213.2445&operId=Roast&seqNo=3

To get the BOM data for BOM position 24 for the job identified by work order WO20171213.2445, operation Roast, and sequence number 3:

api/JobBom?woId=WO20171213.2445&operId=Roast&seqNo=3&bomPos=24

Examples: Work Tasks Lookups

To get the BOM data for a job identified by work order, operation, and sequence number:

api/JobBom?woId={woId}&operId={operId}&seqNo={seqNo}

To get the BOM data for a BOM position of a job:

api/JobBom?woId={woId}&operId={operId}&seqNo={seqNo}&bomPos={bomPos}

All Operations Resource Group | MES Web API V1 Web Service