MES Stateless API

GetAll Method (Job)

Save PDF

GetAll Method (Job)

Save PDF

Last UpdatedNov 06, 2025
10 minute read

The GetAll() method retrieves one or more job records from the Job table, as specified by the filter parameters. Passing no filter parameters will retrieve all job records from the table.

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Nullable(Of Integer), _
   ByVal itemId As String, _
   ByVal stateCd As Nullable(Of JobStateCode), _
   ByVal jobPriority As Nullable(Of Integer), _
   ByVal reqFinishTimeUtc As Nullable(Of Date), _
   ByVal reqFinishTimeLocal As Nullable(Of Date), _
   ByVal initSchedEntId As Nullable(Of Integer), _
   ByVal targetSchedEntId As Nullable(Of Integer), _
   ByVal runEntId As Nullable(Of Integer), _
   ByVal firstJob As Nullable(Of Boolean), _
   ByVal finalJob As Nullable(Of Boolean), _
   ByVal schedStartTimeUtc As Nullable(Of Date), _
   ByVal schedStartTimeLocal As Nullable(Of Date), _
   ByVal latestStartTimeUtc As Nullable(Of Date), _
   ByVal latestStartTimeLocal As Nullable(Of Date), _
   ByVal schedFinishTimeUtc As Nullable(Of Date), _
   ByVal schedFinishTimeLocal As Nullable(Of Date), _
   ByVal actStartTimeUtc As Nullable(Of Date), _
   ByVal actStartTimeLocal As Nullable(Of Date), _
   ByVal actFinishTimeUtc As Nullable(Of Date), _
   ByVal actFinishTimeLocal As Nullable(Of Date), _
   ByVal concurrentLink As Nullable(Of Integer), _
   ByVal parentContingentJob As Nullable(Of Boolean), _
   ByVal childContingentJob As Nullable(Of Boolean), _
   ByVal rework As Nullable(Of Boolean), _
   ByVal reworkCd As String, _
   ByVal reworkProcessId As String, _
   ByVal spare1 As String, _
   ByVal spare2 As String, _
   ByVal spare3 As String, _
   ByVal spare4 As String, _
   ByVal editedBy As String, _
   ByVal editTime As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim woId As String
Dim operId As String
Dim seqNo As Nullable(Of Integer)
Dim itemId As String
Dim stateCd As Nullable(Of JobStateCode)
Dim jobPriority As Nullable(Of Integer)
Dim reqFinishTimeUtc As Nullable(Of Date)
Dim reqFinishTimeLocal As Nullable(Of Date)
Dim initSchedEntId As Nullable(Of Integer)
Dim targetSchedEntId As Nullable(Of Integer)
Dim runEntId As Nullable(Of Integer)
Dim firstJob As Nullable(Of Boolean)
Dim finalJob As Nullable(Of Boolean)
Dim schedStartTimeUtc As Nullable(Of Date)
Dim schedStartTimeLocal As Nullable(Of Date)
Dim latestStartTimeUtc As Nullable(Of Date)
Dim latestStartTimeLocal As Nullable(Of Date)
Dim schedFinishTimeUtc As Nullable(Of Date)
Dim schedFinishTimeLocal As Nullable(Of Date)
Dim actStartTimeUtc As Nullable(Of Date)
Dim actStartTimeLocal As Nullable(Of Date)
Dim actFinishTimeUtc As Nullable(Of Date)
Dim actFinishTimeLocal As Nullable(Of Date)
Dim concurrentLink As Nullable(Of Integer)
Dim parentContingentJob As Nullable(Of Boolean)
Dim childContingentJob As Nullable(Of Boolean)
Dim rework As Nullable(Of Boolean)
Dim reworkCd As String
Dim reworkProcessId As String
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim editedBy As String
Dim editTime As Nullable(Of Date)
Dim value As DataSet
 
value = Job.GetAll(woId, operId, seqNo, itemId, stateCd, jobPriority, reqFinishTimeUtc, reqFinishTimeLocal, initSchedEntId, targetSchedEntId, runEntId, firstJob, finalJob, schedStartTimeUtc, schedStartTimeLocal, latestStartTimeUtc, latestStartTimeLocal, schedFinishTimeUtc, schedFinishTimeLocal, actStartTimeUtc, actStartTimeLocal, actFinishTimeUtc, actFinishTimeLocal, concurrentLink, parentContingentJob, childContingentJob, rework, reworkCd, reworkProcessId, spare1, spare2, spare3, spare4, editedBy, editTime)

public static DataSet GetAll( 
   string woId,
   string operId,
   Nullable<int> seqNo,
   string itemId,
   Nullable<JobStateCode> stateCd,
   Nullable<int> jobPriority,
   Nullable<DateTime> reqFinishTimeUtc,
   Nullable<DateTime> reqFinishTimeLocal,
   Nullable<int> initSchedEntId,
   Nullable<int> targetSchedEntId,
   Nullable<int> runEntId,
   Nullable<bool> firstJob,
   Nullable<bool> finalJob,
   Nullable<DateTime> schedStartTimeUtc,
   Nullable<DateTime> schedStartTimeLocal,
   Nullable<DateTime> latestStartTimeUtc,
   Nullable<DateTime> latestStartTimeLocal,
   Nullable<DateTime> schedFinishTimeUtc,
   Nullable<DateTime> schedFinishTimeLocal,
   Nullable<DateTime> actStartTimeUtc,
   Nullable<DateTime> actStartTimeLocal,
   Nullable<DateTime> actFinishTimeUtc,
   Nullable<DateTime> actFinishTimeLocal,
   Nullable<int> concurrentLink,
   Nullable<bool> parentContingentJob,
   Nullable<bool> childContingentJob,
   Nullable<bool> rework,
   string reworkCd,
   string reworkProcessId,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string editedBy,
   Nullable<DateTime> editTime
)

Parameters

woId: Optional filter parameter. Holds the ID of the work order for a job.
operId: Optional filter parameter. Holds the ID of the operation for a job.
seqNo: Optional filter parameter. Holds the operation sequence number for a job.
itemId: Optional filter parameter. Holds an ID of the item resulting from this job.
stateCd: Optional filter parameter. Holds a JobStateCode enumeration that identifies a job state.
jobPriority: Optional filter parameter. Holds an operation priority.
reqFinishTimeUtc: Optional filter parameter. Holds a required completion date/time in UTC time.
reqFinishTimeLocal: Optional filter parameter. Holds a required completion date/time in the entity's local time.
initSchedEntId: Optional filter parameter. Holds an ID of an entity to which a job is initially scheduled.
targetSchedEntId: Optional filter parameter. Holds an ID of an entity to which a job is actually scheduled.
runEntId: Optional filter parameter. Holds an ID of an entity on which a job is actually run.
firstJob: Optional filter parameter. Holds a flag that specifies whether this is the first operation for the work order.
finalJob: Optional filter parameter. Holds a flag that specifies whether this is the final operation for the work order.
schedStartTimeUtc: Optional filter parameter. Holds a scheduled start time in UTC.
schedStartTimeLocal: Optional filter parameter. Holds a scheduled start time in the entity's local time.
latestStartTimeUtc: Optional filter parameter. Holds the latest start time in UTC to meet a required finish time.
latestStartTimeLocal: Optional filter parameter. Holds the latest start time in the entity's local time to meet a required finish time.
schedFinishTimeUtc: Optional filter parameter. Holds an estimated completion time in UTC.
schedFinishTimeLocal: Optional filter parameter. Holds an estimated completion time in the entity's local time.
actStartTimeUtc: Optional filter parameter. Holds an actual start time in UTC.
actStartTimeLocal: Optional filter parameter. Holds an actual start time in the entity's local time.
actFinishTimeUtc: Optional filter parameter. Holds an actual completion time in UTC.
actFinishTimeLocal: Optional filter parameter. Holds an actual completion time in the entity's local time.
concurrentLink: Optional filter parameter. Holds an integer that is used to match up concurrent jobs.
parentContingentJob: Optional filter parameter. Holds a flag that, if set to true, specifies that a job is for a group that will really be run on one or more children.
childContingentJob: Optional filter parameter. Holds a flag that, if set to true, specifies that a job is a potential job for one of a group of entities.
rework: Optional filter parameter. Holds a flag that, if set to true, specifies that a job has required or does require rework.
reworkCd: Optional filter parameter. Holds the value of the rework code that is to be used for rework sparked from this job.
reworkProcessId: Optional filter parameter. Holds the process id of the rework process this job was created from if this job is for rework.
spare1: Optional filter parameter. Holds the contents of a user-defined spare1 field.
spare2: Optional filter parameter. Holds the contents of a user-defined spare2 field.
spare3: Optional filter parameter. Holds the contents of a user-defined spare3 field.
spare4: Optional filter parameter. Holds the contents of a user-defined spare4 field.
editedBy: Optional. Holds the ID of the user who added or last changed the record.
editTime: Optional. Holds the date/time when the record was added or last updated.

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.
wo_desc	A string that is the work order description, from the WO table.
wo_state_cd	An integer that is the current state of the work order.
req_qty	A floating point number that is the quantity of the item required, from the WO table.
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.
item_desc	A string that is the item description, from the Item table.
serial_no_lvl	An integer that specifies the serialization level, from the Item table. This value is 0 if the lot_no is the serial number, greater than 0 if a particular sublot level is the serial number, and -1 if there are no serial numbers.
num_decimals	An integer that is the number of decimals for formatting numeric values.
num_decimals_good_pp	An integer that is the value of the system_attr 326 Max decimals of good piece part entries and is used when the num_decimals column is zero.
state_cd	An integer that is the current state of the job.
state_desc	A string that specifies the description of the state, from the Job_State table.
color	An integer that is the RGB background color value corresponding to the state, from the Job_State table.
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.
req_finish_time	A datetime that is the required completion date/time in the caller's local time.
init_sched_ent_id	An integer that is the ID of the entity to which the job is initially scheduled.
init_sched_ent_name	A string that is the name of the entity to which the job is initially scheduled, from the Ent table.
target_sched_ent_id	An integer that is the ID of the entity to which the job is actually scheduled.
target_sched_ent_name	A string that is the name of the entity to which the job is actually scheduled, from the Ent table.
run_ent_id	An integer that is the ID of the entity the job is actually run on.
run_ent_name	A string that is the name of the entity on which the job is actually run, from the Ent table.
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.
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.
sched_start_time	A datetime that is the scheduled start time in the caller'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.
latest_start_time	A datetime that is the latest start time in the caller'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.
sched_finish_time	A datetime that is the estimated completion time in the caller'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_start_time	A datetime that is the actual start time in the caller'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.
act_finish_time	A datetime that is the actual completion time in the caller's local time.
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.
sched_pinned	A Boolean that is a flag that specifies whether the start time is fixed and may not be changed.
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

GetAll Method (Job)

Table of Contents

GetAll Method (Job)

In This Topic

MES Stateless API

GetAll Method (Job)

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic