MES Stateless API

GetJobQueue Method

Save PDF

GetJobQueue Method

Save PDF

Last UpdatedNov 06, 2025
6 minute read

The GetJobQueue() method retrieves a list of all the jobs for the specified work order.

Syntax

'Declaration
 
Public Shared Function GetJobQueue( _
   ByVal woId As String, _
   ByVal itemId As String _
) As DataSet

'Usage
 
Dim woId As String
Dim itemId As String
Dim value As DataSet
 
value = JobExec.GetJobQueue(woId, itemId)

public static DataSet GetJobQueue( 
   string woId,
   string itemId
)

Parameters

woId: Required. Holds the ID of the work order.
itemId: Optional. Holds the ID of an item by which to filter the list of jobs.

Return Value

Returns a DataSet that contains records for all jobs of the work order. If the work order has no jobs, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
wo_id	A string that is the work order ID, from the Job table.
oper_id	A string that is the operation ID, from the Job table.
seq_no	An integer that is the 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 item ID, from the Job table.
state_cd	An integer that is the state of the job, from the Job table.
job_priority	An integer that is the job priority, from the Job table.
req_finish_time_utc	A datetime that is the required completion date and time, in UTC. From the Job table.
req_finish_time_local	A datetime that is the required completion date and time, in the local time of the entity. From the Job table.
req_finish_time	A datetime that is the required completion date and time, in the local time of the client application that is making the call. From the Job table.
init_sched_ent_id	An integer that is the entity to which the job is initially scheduled, from the Job table.
target_sched_ent_id	An integer that is the entity to which the job is actually scheduled, from the Job table.
run_ent_id	An integer that is the ID of the entity on which the job actually runs, from the Job table.
qty_reqd	A double floating point value that is the quantity of the item required, from the Job table.
qty_prod	A double floating point value that is the quantity of the item made so far, from the Job table.
qty_prod_erp	A double floating point value that is the quantity made as uploaded to ERP, from the Job table.
qty_rejected	A double floating point value that is the quantity of the item rejected so far, from the Job table.
qty_rejected_erp	A double floating point value that is the quantity rejected as uploaded to ERP, from the Job table.
qty_at_start	A double floating point value that is the quantity expected to be produced if there no scrap/waste/rejects are returned.
deviation_above	A double floating point value that is the maximum high side deviation of total production, relative to the starting quantity.
deviation_below	A double floating point value that is the maximum low side deviation of total production, relative to the starting quantity.
batch_size	A double floating point value that is the amount of product per batch.
first_job	A Boolean that is a flag that indicates whether first operation of the work order is done.
final_job	A Boolean that is a flag that indicates whether the final operation of the work order is done.
sched_pinned	A Boolean that is a flag that indicates whether the start time changeable.
check_inv	A Boolean that is a flag that indicates whether sufficient component inventory is required to change state_cd to 2 (Ready).
est_fixed_lab	A double floating point value that is the estimated fixed labor hours for setup/cleanup.
est_lab_rate	A double floating point value that is the estimated variable labor hour per batch, from the Job table.
est_setup_time	A double floating point value that is the estimated entity hours for setup, from the Job table.
est_teardown_time	A double floating point value that is the estimated entity hours for teardown, from the Job table.
est_prod_rate	A double floating point value that is the estimated entity hours per batch, from the Job table.
prod_uom	An integer that is the production unit of measure (UOM), from the Job table.
est_transfer_time	A double floating point value that is the transfer time after operation - hours, from the Job table.
sched_start_time_utc	A datetime that is the scheduled start time, in UTC.
sched_start_time_local	A datetime that is the scheduled start time, in the local time of the entity.
sched_start_time	A datetime that is the scheduled 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 scheduled finish time, in UTC.
sched_finish_time_local	A datetime that is the scheduled finish time, in the local time of the entity.
sched_finish_time	A datetime that is scheduled the finish 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, in UTC.
act_start_time_local	A datetime that is the actual start time, in the local time of the entity.
act_start_time	A datetime that is the actual start time, in the local time of the client application that is making the call.
act_finish_time_utc	A datetime that is the actual finish time, in UTC.
act_finish_time_local	A datetime that is the actual finish time, in the local time of the entity.
act_finish_time	A datetime that is the actual finish time, in the local time of the client application that is making the call.
concurrent_link	An integer that is the match up concurrent jobs, from the Job table.
job_cost	A double floating point value that is the additional cost associated specifically with this job, from the Job table.
parent_contingent_job	A Boolean that is a flag that indicates whether the job is a placeholder on a group entity and that it will eventually be run on one of more of its child jobs.
child_contingent_job	A Boolean that is a flag that indicates whether the job is for individual entities and which are set for the parent contingent job.
notes	A string that is the specific note for this job typically for a user to read.
assoc_file	A string that is the file path of the associated file, from the Job table.
assoc_file_type	A string that is the type of file of the associated file.
status_notes	A string that is a note regarding job status, typically entered by a user.
display_seq	An integer that is the display sequence of jobs in in the work order.
folder_ver_id	A string that is the optional link to specify a folder version, from the Job table.
rework	A string that is a flag that indicates whether this job has required/does require rework.
sched_pinned	A datetime that is the start time that is not changeable, from the Job table.
spare1	A string that is the content of the user-defined spare1 field, from the Job table.
spare2	A string that is the content of the user-defined spare2 field, from the Job table.
spare3	A string that is the content of the user-defined spare3 field, from the Job table.
spare4	A string that is the content of the user-defined spare4 field, from the Job table.
last_edit_comment	A string that contains comments about why the record was added or updated, from the Job table.
edited_by	A string that is the ID of the user who added or last updated this record, from the Job table.
edit_time	A datetime that indicates when the record was added or last updated, from the Job table.
wo_desc	The work order description, from the Wo table.
req_qty	The quantity of item required, from the Wo table.
mo_id	The modification ID, indicating when the record was added or last updated, from the Wo table.
item_desc	The item description, from the Item table.
state_desc	The state description, from the Job_State table.
color	The RGB background color, from the Job_State table.
ent_name	The unique entity name, from the Ent table.
run_ent_name	The running entity name, from the Ent table.
spare1 to spare4	Strings that are the contents of the user-defined spare1 to spare4 fields, from Item table.

MES Stateless API

GetJobQueue Method

Table of Contents

GetJobQueue Method

In This Topic

MES Stateless API

GetJobQueue Method

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic