MES Stateless API

GetByKey Method (Job)

Save PDF

GetByKey Method (Job)

Save PDF

Last UpdatedNov 06, 2025
5 minute read

The GetByKey() method retrieves the specified job record from the Job table.

Syntax

'Declaration
 
Public Shared Function GetByKey( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Integer _
) As DataSet

'Usage
 
Dim woId As String
Dim operId As String
Dim seqNo As Integer
Dim value As DataSet
 
value = Job.GetByKey(woId, operId, seqNo)

public static DataSet GetByKey( 
   string woId,
   string operId,
   int seqNo
)

Parameters

woId: Required. Holds the string which identifies the work order for the job.
operId: Required. Holds the string which identifies the operation for the job.
seqNo: Required. Holds the integer which identifies the sequence number for the operation.

Return Value

Returns a DataSet that contains all the records in the Job 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 work order ID for the job.
oper_id	A string that is the operation ID for the job.
seq_no	An integer that is the operation sequence number for the job.
job_desc	A string that is the description of the job.
item_id	A string that is the ID of the item resulting from this job.
state_cd	An integer that is the current state of the job.
job_priority	An integer that is the operation priority.
req_finish_time_utc	A datetime that is the required completion date/time in UTC.
req_finish_time_local	A datetime that is the required completion date/time in the entity's local time.
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 the job is actually run on.
qty_reqd	A floating point number that is the quantity of the item required.
qty_prod	A floating point number that is the quantity of the item made so far.
qty_prod_erp	A floating point number that is the quantity produced as uploaded to ERP.
qty_rejected	A floating point number that is the quantity of the item rejected so far.
qty_rejected_erp	A floating point number that is the quantity rejected as uploaded to ERP.
qty_at_start	A floating point number that is the quantity expected to be produced if there are no scrap/waste/rejects.
deviation_above	A floating point number that is the portion of the start quantity by which total production can deviate above.
deviation_below	A floating point number that is the portion of start quantity by which total production can deviate below.
batch_size	A floating point number that is the amount of product per batch.
first_job	A Boolean that is a flag that specifies whether this is the first operation for the work order.
final_job	A Boolean that is a flag that specifies whether this is the final operation for the work order.
sched_pinned	A Boolean that is a flag that specifies whether the start time is fixed and may not be changed.
check_inv	A Boolean that is a flag that specifies whether sufficient component inventory is required to change the state to ‘Ready’.
est_fixed_lab	A floating point number that is the estimated fixed labor hours for setup and cleanup.
est_lab_rate	A floating point number that is the estimated variable labor batch time, depending on prod_uom.
est_setup_time	A floating point number that is the estimated entity hours for setup.
est_teardown_time	A floating point number that is the estimated entity hours for teardown.
est_prod_rate	A floating point number that is the estimated entity batch rate or time, depending on prod_uom.
prod_uom	An integer specifying the unit of measure for est_lab_rate and est_prod_rate.
est_transfer_time	A floating point number that is the transfer time (in hours) after the operation.
sched_start_time_utc	A datetime value that is scheduled start time in UTC.
sched_start_time_local	A datetime that is the scheduled start time in the entity's local time.
latest_start_time_utc	A datetime that is the latest start time in UTC to meet the required finish time.
latest_start_time_local	A datetime that is the latest start time in the entity's local time to meet the required finish time.
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 entity's local time.
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 entity's local time.
act_finish_time_utc	A datetime that is the actual completion time in UTC.
act_finish_time_local	A datetime that is the actual completion time in the entity's local time.
target_finish_time_utc	The target finish time in UTC, calculated from the actual start time UTC, the configured production rate, and the total quantity to be produced.
target_finish_local	The target finish time local to the entity, calculated from target_finish_time_utc based on the entity’s time zone.
target_finish_time	The target finish time local to the user, calculated from the target_finish_time_utc based on the user’s time zone.
cur_rate_finish_time_utc	The estimated finish time in UTC, based on the current production rate. The current production rate is calculated and used to calculate how long it will take to produce the remaining amount based on that production rate. Null if there is no production at this point.
cur_rate_finish_time_local	The estimated finish time local to the entity, calculated from the cur_rate_finish_time_utc based on the entity’s time zone.
cur_rate_finish_time	The estimated finish time local to the user, calculated from the cur_rate _finish_time_utc based on the user’s time zone.
std_rate_finish_time_utc	The standard finish time in UTC, calculated from the current time, the configured production rate, and the remaining quantity to be produced.
std_rate_finish_time_local	The standard finish time local to the entity, calculated from the std_rate_finish_time_utc based on the entity’s time zone.
std_rate_finish_time	The standard finish time local to the user, calculated from the std_rate_finish_time_utc based on the user’s time zone.
concurrent_link	An integer used to match up concurrent jobs.
job_cost	A floating point number that is the additional (i.e., non-labor, non-machine, and non-material) cost associated specifically with this job.
parent_contingent_job	A Boolean that is a flag that specifies whether the job is for a group that will really be run on one or more children.
child_contingent_job	A Boolean that is a flag that specifies whether the job is a potential job for one of a group of entities.
notes	A string that is specific notes for this job; typically for the operator to read.
assoc_file	A string that is the path and file name of the file associated with the job.
assoc_file_type	A string that is the file type of the file associated with the job.
status_notes	A string that is notes regarding job status; typically operator-entered (e.g., when suspending the job).
display_seq	An integer specifying the sequence of jobs independently of oper_id. Used to sequence jobs in trees and flow diagrams.
folder_ver_id	A string that is an optional link to specify a folder version for the job.
rework	A Boolean that is a flag that specifies whether the job has required or does require rework.
rework_cd	An integer specifying the rework behavior of this job.
rework_process_id	An integer specifying the process ID for the rework.
spare1	A user-defined string value.
spare2	A user-defined string value.
spare3	A user-defined string value.
spare4	A user-defined string value.
last_edit_comment	A string that is a comment that explains why the record was changed.
edited_by	A string that is the ID of the user who added or last modified this record.
edit_time	The date and time when the record was added or last modified.
row_id	An integer that is a unique identifier for the record.

MES Stateless API

GetByKey Method (Job)

Table of Contents

GetByKey Method (Job)

In This Topic

MES Stateless API

GetByKey Method (Job)

Syntax

Parameters

Return Value

See Also

Reference

In This Topic