MES Stateless API

GetBatchOfJobs(Int32,Int32) Method

Save PDF

GetBatchOfJobs(Int32,Int32) Method

Save PDF

Last UpdatedNov 06, 2025
7 minute read

The GetBatchOfJobs() method retrieves all jobs queued to an entity, or any of its ancestors for which jobs can be queued, that are part of the specified batch.

This overload of the method uses the entity ID to identify the entity.

Syntax

'Declaration
 
Public Overloads Shared Function GetBatchOfJobs( _
   ByVal entId As Integer, _
   ByVal concurrentLink As Integer _
) As DataSet

'Usage
 
Dim entId As Integer
Dim concurrentLink As Integer
Dim value As DataSet
 
value = JobExec.GetBatchOfJobs(entId, concurrentLink)

public static DataSet GetBatchOfJobs( 
   int entId,
   int concurrentLink
)

Parameters

entId: Required. Holds the ID of the entity.
concurrentLink: Required. Holds the concurrent link number (i.e., the batch number).

Return Value

Returns a DataSet of all batch jobs that are queued to the supplied entity or to any of its preferred ancestors whose concurrent link number is equal to the supplied concurrent link number. However, jobs that are finished or cancelled are excluded from the DataSet . If no rows are found for the supplied parameters, 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, from the Job table.
oper_id	A string that is the operation ID of the job, from the Job table.
seq_no	An integer that is the job sequence number, from the Job table.
job_desc	A string that is the description of the job, from the Job table.
item_id	A string that is the ID of an item resulting from this job.
state_cd	An integer that is the state of the job.
job_priority	An integer that is the operation priority.
req_finish_time_utc	A datetime that is the required completion time, in UTC.
req_finish_time_local	A datetime that is the required completion time, in the local time of the entity.
req_finish_time	A datetime that is the required completion time, in the local time of the client application that is making the call.
init_sched_ent_id	An integer that is the ID of the entity to which the job is initially scheduled.
target_sched_ent_id	An integer that is the ID of the entity to which the job is actually scheduled.
run_ent_id	An integer that is the ID of the entity that actually ran this job.
qty_reqd	A double floating point that is the amount of quantity required before completing this job.
qty_prod	A double floating point that is the amount of quantity produced so far.
qty_prod_erp	A double floating point that is the amount of quantity uploaded to ERP.
qty_rejected	A double floating point that is the amount of quantity rejected so far.
qty_rejected_erp	A double floating point that is the amount of quantity uploaded to ERP.
qty_at_start	A double floating point that is the quantity expected to produce if there are no scrap/waste/rejects.
deviation_above	A double floating point that is the portion of start quantity by which total production may deviate above it. Defaults to the value of system attribute 103 if not created from a process.
deviation_below	A double floating point that is the portion of start quantity by which total production may deviate below it. Defaults to the value of system attribute 104 if not created from a process.
batch_size	A double floating point that is the amount of product per batch, in case it is used to force multiples of production.
first_job	A Boolean that is a flag that indicates whether this is the first job in the work order.
final_job	A Boolean that is a flag that indicates whether this is the final job in the work order.
sched_pinned	A Boolean that is a flag that indicates whether the start time can be changed.
check_inv	A Boolean that is a flag that indicates whether the job state can be changed to read without having sufficient quantities.
est_fixed_lab	A double floating point that is the estimated fixed labor hours for setup and cleaning, etc.
est_lab_rate	A double floating point that is the estimated variable labor batch rate or time.
est_setup_time	A double floating point that is the estimated setup time (in hours) for this entity.
est_teardown_time	A double floating point that is the estimated teardown time (in hours) for this entity.
est_prod_rate	A double floating point that is the entity batch rate or time.
prod_uom	An enumeration that identifies the unit of measurement for est_lat_rate and est_prod_rate.
est_transfer_time	A double floating point that is the estimated transfer time after operation (in hours).
sched_start_time_utc	A datetime that is the schedule start time, in UTC.
sched_start_time_local	A datetime that is the schedule start time, in the local time of the entity.
sched_start_time	A datetime that is the schedule start time, in the local time of the client application that is making the call.
latest_start_time_utc	A datetime that is the latest start time to meet the required finish time, in UTC.
latest_start_time_local	A datetime that is the latest start time to meet the required finish time, in the local time of the entity.
latest_start_time	A datetime that is the latest start time to meet the required finish time, in the local time of the client application that is making the call.
sched_finish_time_utc	A datetime that is the estimated completion time, in UTC.
sched_finish_time_local	A datetime that is the estimated completion time, in the local time of the entity.
sched_finish_time	A datetime that is the estimated completion time, in the local time of the client application that is making the call.
act_start_time_utc	A datetime that is the actual start time of this job the first time the job was ever started (in case of restarts), in UTC.
act_start_time_local	A datetime that is the actual start time of this job the first time the job was ever started (in case of restarts), in the local time of the entity.
act_start_time	A datetime that is the actual start time of this job the first time the job was ever started (in case of restarts), in the local time of the client application that is making the call.
act_finish_time_utc	A datetime that is the actual completion time of this job the last time the job was ever completed (in case of restarts), in UTC.
act_finish_time_local	A datetime that is the actual completion time of this job the last time the job was ever completed (in case of restarts), in the local time of the entity.
act_finish_time	A datetime that is the actual completion time of this job the last time the job was ever completed (in case of restarts), in the local time of the client application that is making the call.
concurrent_link	An integer that is the concurrent jobs.
job_cost	A double floating point that is the cost associated specifically with this job.
parent_contingent_job	A Boolean that is a flag that indicates whether this job for a group will really be run on one or more children.
child_contingent_job	A Boolean that is a flag that indicates whether this job for one of a group of entities.
notes	A string that is the notes for this job.
assoc_file	A string that is the file path of the associated file.
assoc_file_type	A string that is the type of file of the associated file.
status_notes	A string that is the status of the job; typically user-entered when suspending a job, etc.
display_seq	An integer that is the sequence of jobs independent of operation.
folder_ver_id	A string that is a link to specify a folder version for this job.
rework	A Boolean that is a flag that indicates whether this job has required/does require rework.
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.
last_edit_comment	A string that contains comments about why the record was added or updated.
edited_by	A string that is the ID of the user who added or last updated this record.
edit_time	A datetime that indicates when the record was added or last updated.
row_id	An integer that is the unique row ID of the record.
wo_desc	A string that is the description of the work oder, from the wo.wo_desc column linking this job.
req_qty	A double floating point that is the quantity of item required, from the wo.req_qty column linking this job.
mo_id	A string that is the manufacturing order to group different final parts, from the wo.mo_id column linking this job.
item_desc	A string that is the description of this item, from the item.item_desc column linking the item for this job.
state_desc	A string that is the description of the job state, from the job_state.state_desc linking the state code for this job.
color	An integer value that identifies the background color that should be displayed on the user interface when this job is selected.
ent_name	A string that is the name of the entity, from the ent.ent_name column linking the job.target_sched_ent_id column for this row.
run_ent_name	A string that is the name of the entity, from the ent.ent_name column linking the job.run_ent_id column for this row.
item_spare1	A string that is the spare1 value, from the item.spare1 linking this item for this job.
item_spare2	A string that is the spare2 value, from the item.spare2 linking this item for this job.
item_spare3	A string that is the spare3 value, from the item.spare3 linking this item for this job.
item_spare4	A string that is the spare4 value, from the item.spare4 linking this item for this job.
lifetime	An integer that is the lifetime of this item in days, from the item.lifetime column linking the item that is produced in this job.
description	A string that is the description of the unit of measurement for this item, from the uom.description column linking the item produced in this job.
abbreviation	A string that is the abbreviation of this item (uom.abbreviation) linking the item produced in this job.
def_lot_no	A string that is the default lot number, from the the job_bom.def_lot_no linking this job at BOM position 0.
process_id	A string that is the ID of the process, from the wo.process_id linking this job.

MES Stateless API