MES Stateless API

GetProdByFilter(String,String,Nullable<Int32>,Nullable<Int32>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,String,String,String,String,String,String,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Double>,Nullable<Double>,String,String,String,Nullable<Boolean>,Nullable<Int32>,Nullable<Boolean>,Nullable<Int32>,String,String,String,String,String,String,String,String,String,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<Int32>) Method

Save PDF

GetProdByFilter(String,String,Nullable<Int32>,Nullable<Int32>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,String,String,String,String,String,String,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Double>,Nullable<Double>,String,String,String,Nullable<Boolean>,Nullable<Int32>,Nullable<Boolean>,Nullable<Int32>,String,String,String,String,String,String,String,String,String,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<DateTime>,Nullable<Int32>) Method

Save PDF

Last UpdatedNov 06, 2025
10 minute read

The GetProdByFilter() method retrieves item production records based on the supplied filters.

This overload of the method includes the shiftStartUtcStart, shiftStartUtcEnd, hourStartStart, hourStartEnd, createdAtUtcStart, and createdAtUtcEnd filter parameters.

Syntax

'Declaration
 
Public Overloads Shared Function GetProdByFilter( _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Nullable(Of Integer), _
   ByVal shiftId As Nullable(Of Integer), _
   ByVal shiftStartStart As Nullable(Of Date), _
   ByVal shiftStartEnd As Nullable(Of Date), _
   ByVal shiftStartUtcStart As Nullable(Of Date), _
   ByVal shiftStartUtcEnd As Nullable(Of Date), _
   ByVal hourStartStart As Nullable(Of Date), _
   ByVal hourStartEnd As Nullable(Of Date), _
   ByVal itemId As String, _
   ByVal itemDesc As String, _
   ByVal lotNo As String, _
   ByVal rmLotNo As String, _
   ByVal subLotNo As String, _
   ByVal rmSubLotNo As String, _
   ByVal reasCd As Nullable(Of Integer), _
   ByVal gradeCd As Nullable(Of Integer), _
   ByVal statusCd As Nullable(Of Integer), _
   ByVal runEntId As Nullable(Of Integer), _
   ByVal storageEntId As Nullable(Of Integer), _
   ByVal qtyMin As Nullable(Of Double), _
   ByVal qtyMax As Nullable(Of Double), _
   ByVal userId As String, _
   ByVal userDesc As String, _
   ByVal extRef As String, _
   ByVal goodProd As Nullable(Of Boolean), _
   ByVal processedFlag As Nullable(Of Integer), _
   ByVal byproduct As Nullable(Of Boolean), _
   ByVal moveStatus As Nullable(Of Integer), _
   ByVal genealogyId As String, _
   ByVal eventId As String, _
   ByVal segmentRequirementId As String, _
   ByVal segmentResponseId As String, _
   ByVal comments As String, _
   ByVal spare1 As String, _
   ByVal spare2 As String, _
   ByVal spare3 As String, _
   ByVal spare4 As String, _
   ByVal createdAtStart As Nullable(Of Date), _
   ByVal createdAtEnd As Nullable(Of Date), _
   ByVal createdAtUtcStart As Nullable(Of Date), _
   ByVal createdAtUtcEnd As Nullable(Of Date), _
   ByVal rowId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim woId As String
Dim operId As String
Dim seqNo As Nullable(Of Integer)
Dim shiftId As Nullable(Of Integer)
Dim shiftStartStart As Nullable(Of Date)
Dim shiftStartEnd As Nullable(Of Date)
Dim shiftStartUtcStart As Nullable(Of Date)
Dim shiftStartUtcEnd As Nullable(Of Date)
Dim hourStartStart As Nullable(Of Date)
Dim hourStartEnd As Nullable(Of Date)
Dim itemId As String
Dim itemDesc As String
Dim lotNo As String
Dim rmLotNo As String
Dim subLotNo As String
Dim rmSubLotNo As String
Dim reasCd As Nullable(Of Integer)
Dim gradeCd As Nullable(Of Integer)
Dim statusCd As Nullable(Of Integer)
Dim runEntId As Nullable(Of Integer)
Dim storageEntId As Nullable(Of Integer)
Dim qtyMin As Nullable(Of Double)
Dim qtyMax As Nullable(Of Double)
Dim userId As String
Dim userDesc As String
Dim extRef As String
Dim goodProd As Nullable(Of Boolean)
Dim processedFlag As Nullable(Of Integer)
Dim byproduct As Nullable(Of Boolean)
Dim moveStatus As Nullable(Of Integer)
Dim genealogyId As String
Dim eventId As String
Dim segmentRequirementId As String
Dim segmentResponseId As String
Dim comments As String
Dim spare1 As String
Dim spare2 As String
Dim spare3 As String
Dim spare4 As String
Dim createdAtStart As Nullable(Of Date)
Dim createdAtEnd As Nullable(Of Date)
Dim createdAtUtcStart As Nullable(Of Date)
Dim createdAtUtcEnd As Nullable(Of Date)
Dim rowId As Nullable(Of Integer)
Dim value As DataSet
 
value = ItemProd.GetProdByFilter(woId, operId, seqNo, shiftId, shiftStartStart, shiftStartEnd, shiftStartUtcStart, shiftStartUtcEnd, hourStartStart, hourStartEnd, itemId, itemDesc, lotNo, rmLotNo, subLotNo, rmSubLotNo, reasCd, gradeCd, statusCd, runEntId, storageEntId, qtyMin, qtyMax, userId, userDesc, extRef, goodProd, processedFlag, byproduct, moveStatus, genealogyId, eventId, segmentRequirementId, segmentResponseId, comments, spare1, spare2, spare3, spare4, createdAtStart, createdAtEnd, createdAtUtcStart, createdAtUtcEnd, rowId)

public static DataSet GetProdByFilter( 
   string woId,
   string operId,
   Nullable<int> seqNo,
   Nullable<int> shiftId,
   Nullable<DateTime> shiftStartStart,
   Nullable<DateTime> shiftStartEnd,
   Nullable<DateTime> shiftStartUtcStart,
   Nullable<DateTime> shiftStartUtcEnd,
   Nullable<DateTime> hourStartStart,
   Nullable<DateTime> hourStartEnd,
   string itemId,
   string itemDesc,
   string lotNo,
   string rmLotNo,
   string subLotNo,
   string rmSubLotNo,
   Nullable<int> reasCd,
   Nullable<int> gradeCd,
   Nullable<int> statusCd,
   Nullable<int> runEntId,
   Nullable<int> storageEntId,
   Nullable<double> qtyMin,
   Nullable<double> qtyMax,
   string userId,
   string userDesc,
   string extRef,
   Nullable<bool> goodProd,
   Nullable<int> processedFlag,
   Nullable<bool> byproduct,
   Nullable<int> moveStatus,
   string genealogyId,
   string eventId,
   string segmentRequirementId,
   string segmentResponseId,
   string comments,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   Nullable<DateTime> createdAtStart,
   Nullable<DateTime> createdAtEnd,
   Nullable<DateTime> createdAtUtcStart,
   Nullable<DateTime> createdAtUtcEnd,
   Nullable<int> rowId
)

Parameters

woId: Optional filter parameter. Holds the work order ID for identifying the job that produced an item.
operId: Optional filter parameter. Holds the operation ID for identifying the job that produced an item.
seqNo: Optional filter parameter. Holds the operation sequence number for identifying the job that produced an item.
shiftId: Optional filter parameter. Holds the ID of the shift during which an item was produced.
shiftStartStart: Optional filter parameter. Holds the start time of the shift during which an item was produced.
shiftStartEnd: Optional filter parameter. Holds the end time of the shift during which an item was produced.
shiftStartUtcStart: Optional filter parameter. Holds the start time of the shift during which an item was produced (universal time).
shiftStartUtcEnd: Optional filter parameter. Holds the end time of the shift during which an item was produced (universal time).
hourStartStart: Optional filter parameter. Holds the start time hour in which time and production occurred
hourStartEnd: Optional filter parameter. Holds the end time hour in which time and production occurred
itemId: Optional filter parameter. Holds an item ID.
itemDesc: Optional filter parameter. Holds an item description.
lotNo: Optional filter parameter. Holds the lot number to which an item belongs.
rmLotNo: Optional filter parameter. Holds the lot number of the raw material from which a lot/sublot was produced.
subLotNo: Optional filter parameter. Holds the sublot number to which an item belongs.
rmSubLotNo: Optional filter parameter. Holds the sublot number of the raw material from which a lot/sublot was produced.
reasCd: Optional filter parameter. Holds a reason code that uniquely identifies grade + status of goods produced.
gradeCd: Optional filter parameter. Holds the grade code of a produced item.
statusCd: Optional filter parameter. Holds the status code of a produced item.
runEntId: Optional. Holds the ID of the entity on which the job that produced an item is running.
storageEntId: Optional filter parameter. Holds the ID of the storage entity to which the produced item was moved.
qtyMin: Optional filter parameter. Holds the minimum amount of an item that must be produced.
qtyMax: Optional filter parameter. Holds the maximum amount of an item that must be produced.
userId: Optional filter parameter. Holds the ID of the user who ran the job that produced an item.
userDesc: Optional filter parameter. Holds the description of the user who ran the job that produced an item.
extRef: Optional filter parameter. Holds the reference to the external system for defect tracking or any other purpose.
goodProd: Optional filter parameter. Holds a flag that specifies whether an item is designated as good production.
processedFlag: Optional filter parameter. Holds a flag that specifies whether an item was processed.
byproduct: Optional filter parameter. Holds a flag that specifies whether an item is a by-product.
moveStatus: Optional filter parameter. Holds an integer that indicates whether the lot been moved to the next operation.

0=not moved to the next operation

1=moved to the next operation
genealogyId: Optional filter parameter. Holds the genealogy ID.
eventId: Optional filter parameter. Holds the event ID.
segmentRequirementId: Optional filter parameter. Holds the segment requirement ID.
segmentResponseId: Optional filter parameter. Holds the segment response ID.
comments: Optional filter parameter. Holds comments about the produced item.
spare1: Optional filter parameter. Holds the contents of the user-defined spare1 field.
spare2: Optional filter parameter. Holds the contents of the user-defined spare2 field.
spare3: Optional filter parameter. Holds the contents of the user-defined spare3 field.
spare4: Optional filter parameter. Holds the contents of the user-defined spare4 field.
createdAtStart: Optional filter parameter. Holds the start date/time when this type of record was created.
createdAtEnd: Optional filter parameter. Holds the end date/time when this type of record was created.
createdAtUtcStart: Optional filter parameter. Holds the start date/time when this type of record was created (universal time).
createdAtUtcEnd: Optional filter parameter. Holds the end date/time when this type of record was created (universal time).
rowId: Optional filter parameter. Holds the row ID of an item production record.

Return Value

Returns a DataSet that contains all the records in the Item_Prod 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
row_id	An integer that is the unique row ID.
wo_id	A string that is the work order ID.
oper_id	A string that is the operation ID.
seq_no	An integer that is the sequence number that indicates the Job table row.
shift_start_utc	A datetime that is the time of the shift start in UTC.
shift_start_local	A datetime that is the time of the shift start in the local time of the entity at which the production occurred.
shift_start	A datetime that is the time of the shift start in the local time of the client application that is making the call.
hour_start_utc	A datetime that is the hour, in UTC, in which production occurred. The minutes portion will not be 0 if the time zone is not an integer number of hours from UTC. The seconds portion will always be 0.
hour_start_local	A datetime that is the hour in the local time of the entity at which the production occurred. The minutes and seconds portion will always be 0.
hour_start	A datetime that is the hour in the local time of the client application that is making the call. The minutes and seconds portion will always be 0.
item_id	A string that is the item ID.
item_desc	A string that is the item description, from the Item table.
uom_id	An integer that is the ID of the unit of measure for this item, from the Item table.
num_decimals	An integer that is the number of decimal places for quantities of this item.
serial_no_lvl_h	An integer that indicates the level being used, lot or sublot, to indicate individual serial numbers, from the Item table 0: The lot number is the serial number. > 0: A particular sublot level is the serial number. -1: There are no serial numbers.
description	A string that is the unique description of the UOM, from the Uom table.
abbreviation	A string that is the UOM abbreviation to append to quantities, from the Uom table.
lifetime	An integer that is the lifetime of the item before it expires, in days; from the Item table.
lot_no	A string that is the lot number.
rm_lot_no	A string that is the lot number of raw material from which this lot/sublot was produced.
sublot_no	A string that is the sublot number.
rm_sublot_no	A string that is the sublot number of raw material from which this lot/sublot was produced.
reas_cd	An integer that is the reason that uniquely identifies grade + status of goods produced.
reas_desc	A string that is the description of the reason, from the Item_Reas table.
user_id	A string that is the ID of the user who ran the job that produced the item.
user_desc	A string that is the user description of the user who ran the job that produced the item, from the User_Name table
ent_id	An integer that is the ID of the entity at which the item was produced.
ent_name	A string that is the name of the entity at which the item was produced, from the Ent table.
shift_id	An integer that is ID of the shift during which the item was produced.
shift_desc	A string that is the description of the shift during which the item was produced, from the Shift table.
grade_cd	An integer that is the grade code of produced goods.
item_grade_desc	A string that is the grade description of produced goods, from the Item_Grade table.
item_grade_color	An integer that is RGB background color of the item grade, from the Item_Grade table.
status_cd	An integer that is the status code of produced goods.
item_status_desc	A string that is the status description, from the Item_State table.
item_state_color	An integer that is RGB background color of the item state, from the Item_State table.
to_ent_id	An integer that is ID of the storage entity for produced goods.
to_ent_name	A string that is the name of the storage entity for produced goods, from the Ent table.
good_prod	A Boolean that is a flag that specifies whether this production is good.
qty_prod	A double that is the quantity produced.
qty_prod_erp	A double that is the quantity produced value that was report to an ERP system.
processed_flag	An integer that is the processed flag for this lot.
byproduct	A Boolean that is a flag that specifies whether the produced item is by-product.
ext_ref	A string that is the reference to an external system for defect tracking or any other purpose.
move_status	An integer that acts as a flag to indicate whether this lot has been moved to the next operation.
genealogy_id	A string that is the genealogy ID.
event_id	A string that is the event ID.
segment_requirement_id	A string that is the segment requirement ID.
segment_response_id	A string that is the segment response ID.
comments	A string that is the comments about the item production.
spare1	A string that is the content of the user-defined spare1 field.
spare2	A string that is the content of the user-defined spare2 field.
spare3	A string that is the content of the user-defined spare3 field.
spare4	A string that is the content of the user-defined spare4 field.
item_spare1	A string that is the content of the user-defined spare1 field of the item.
item_spare2	A string that is the content of the user-defined spare2 field of the item.
item_spare3	A string that is the content of the user-defined spare3 field of the item.
item_spare4	A string that is the content of the user-defined spare4 field of the item.
last_edit_comment	A string that contains comments about why the record was added or updated.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A datetime that indicates when the record was added or last updated.
created_at_utc	A datetime that is when the record was created, in UTC.
created_at_local	A datetime that is when the record was created, in the local time of the entity at which the production occurred.
created_at	A datetime that is when the record was created, in the local time of the client application that is making the call.
row_id	An integer that is the row's unique row ID.
serial_no_lvl	An integer that indicates whether the serial number is based on the item's lot number or not. If the serial number level value of the item is 0 (that is, the serial number is at the lot number level) and the work order's spare1 field is 0, a 0 is returned. Otherwise, a -1 is returned.

MES Stateless API

Table of Contents

In This Topic

MES Stateless API

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic