MES Stateless API

GetAll Method (ItemCons)

Save PDF

GetAll Method (ItemCons)

Save PDF

Last UpdatedMar 17, 2026
7 minute read

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

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal rowId As Nullable(Of Integer), _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Nullable(Of Integer), _
   ByVal shiftStartUtc As Nullable(Of Date), _
   ByVal shiftStartLocal As Nullable(Of Date), _
   ByVal itemId As String, _
   ByVal lotNo As String, _
   ByVal fgLotNo As String, _
   ByVal subLotNo As String, _
   ByVal fgSubLotNo As String, _
   ByVal reasCd As Nullable(Of Integer), _
   ByVal userId As String, _
   ByVal itemScrapped As Nullable(Of Boolean), _
   ByVal entId As Nullable(Of Integer), _
   ByVal shiftId As Nullable(Of Integer), _
   ByVal gradeCd As Nullable(Of Integer), _
   ByVal statusCd As Nullable(Of Integer), _
   ByVal fromEntId As Nullable(Of Integer), _
   ByVal extRef As String, _
   ByVal transactionType As Nullable(Of Integer), _
   ByVal genealogyId As String, _
   ByVal upstreamEventId 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 lastEditBy As String, _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim rowId As Nullable(Of Integer)
Dim woId As String
Dim operId As String
Dim seqNo As Nullable(Of Integer)
Dim shiftStartUtc As Nullable(Of Date)
Dim shiftStartLocal As Nullable(Of Date)
Dim itemId As String
Dim lotNo As String
Dim fgLotNo As String
Dim subLotNo As String
Dim fgSubLotNo As String
Dim reasCd As Nullable(Of Integer)
Dim userId As String
Dim itemScrapped As Nullable(Of Boolean)
Dim entId As Nullable(Of Integer)
Dim shiftId As Nullable(Of Integer)
Dim gradeCd As Nullable(Of Integer)
Dim statusCd As Nullable(Of Integer)
Dim fromEntId As Nullable(Of Integer)
Dim extRef As String
Dim transactionType As Nullable(Of Integer)
Dim genealogyId As String
Dim upstreamEventId 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 lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = ItemCons.GetAll(rowId, woId, operId, seqNo, shiftStartUtc, shiftStartLocal, itemId, lotNo, fgLotNo, subLotNo, fgSubLotNo, reasCd, userId, itemScrapped, entId, shiftId, gradeCd, statusCd, fromEntId, extRef, transactionType, genealogyId, upstreamEventId, segmentRequirementId, segmentResponseId, comments, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   Nullable<int> rowId,
   string woId,
   string operId,
   Nullable<int> seqNo,
   Nullable<DateTime> shiftStartUtc,
   Nullable<DateTime> shiftStartLocal,
   string itemId,
   string lotNo,
   string fgLotNo,
   string subLotNo,
   string fgSubLotNo,
   Nullable<int> reasCd,
   string userId,
   Nullable<bool> itemScrapped,
   Nullable<int> entId,
   Nullable<int> shiftId,
   Nullable<int> gradeCd,
   Nullable<int> statusCd,
   Nullable<int> fromEntId,
   string extRef,
   Nullable<int> transactionType,
   string genealogyId,
   string upstreamEventId,
   string segmentRequirementId,
   string segmentResponseId,
   string comments,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

rowId: Optional. Holds the row ID of an item consumption record.
woId: Optional filter parameter. Holds the work order ID for identifying the job that consumed an item.
operId: Optional filter parameter. Holds the operation ID for identifying the job that consumed an item.
seqNo: Optional filter parameter. Holds the operation sequence number for identifying the job that consumed an item.
shiftStartUtc: Optional filter parameter. Holds the start time of the shift during which an item was consumed, in UTC.
shiftStartLocal: Optional filter parameter. Holds the start time of the shift during which an item was consumed, in the local time of the entity at which the consumption occurred.
itemId: Optional filter parameter. Holds the ID of a consumed item.
lotNo: Optional filter parameter. Holds the lot number of a consumed item.
fgLotNo: Optional. Holds the lot number of finished goods.
subLotNo: Optional filter parameter. Holds the sublot number of a consumed item.
fgSubLotNo: Optional. Holds the sublot number of finished goods.
reasCd: Optional filter parameter. Holds a reason code that uniquely identifies grade + status of goods consumed.
userId: Optional filter parameter. Holds the ID of the user who ran the job that consumed an item.
itemScrapped: Optional filter parameter. Holds a flag that specifies whether an item is designated as scrapped.
entId: Optional filter parameter. Holds the ID of the entity on which the job that consumed an item is running.
shiftId: Optional filter parameter. Holds the ID of the shift during which an item was consumed.
gradeCd: Optional filter parameter. Holds the grade code of consumed goods.
statusCd: Optional filter parameter. Holds the status code of consumed goods.
fromEntId: Optional filter parameter. Holds the ID of the storage entity from which the consumed item was moved.
extRef: Optional filter parameter. Holds the reference to the external system for defect tracking or any other purpose.
transactionType: Optional filter parameter. Holds an enumeration that indicates the transaction type.

0 = normal

1 = lot split

2 = combination
genealogyId: Optional filter parameter. Holds an genealogy ID.
upstreamEventId: Optional filter parameter. Holds the ID of an upstream event.
segmentRequirementId: Optional filter parameter. Holds a segment requirement ID.
segmentResponseId: Optional filter parameter. Holds a segment response ID.
comments: Optional filter parameter. Holds comments about the consumed 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.
lastEditBy: Optional filter parameter. Holds the ID of the user who added or last updated a item consumption record.
lastEditAt: Optional filter parameter. Holds the date/time when an item consumption record was added or last updated.

Return Value

Returns a DataSet that contains records for all the item consumptions that satisfy the specified filters. The returned records include columns from the Item_Cons, Item_Reas, Item_Grade, Item_State, and Ent tables. If no matching item consumptions 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 record’s unique row ID.
wo_id	A string that is the work order ID for identifying the job that consumed the item.
oper_id	A string that is the operation ID for identifying the job that consumed the item.
seq_no	An integer that is the operation sequence number for identifying the job that consumed the item.
shift_start_utc	A datetime that is the time of the shift start in UTC time.
shift_start_local	A datetime that is the time of the shift start in the local time of the entity at which the consumption 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.
item_id	A string that is the ID of the consumed item.
lot_no	A string that is the lot number of the consumed item.
fg_lot_no	A string that is the lot number of the parent item.
sublot_no	A string that is the sublot number of consumed item.
fg_sublot_no	A string that is the sublot number of the parent item.
reas_cd	An integer that is reason that uniquely identifies the grade + status of goods consumed.
user_id	A string that is the ID of the user who ran the job that consumed the item.
item_desc	A string that is the item description, from the Item table.
reas_desc	A string that is the reason description, from the Item_Reas table.
item_scrapped	A Boolean that is a flag that specifies whether the consumed item is waste.
ent_id	An integer that is the ID of the entity at which the item was consumed.
ent_name	A string that is the name of the entity at which the item was consumed, from the Ent table.
shift_id	An integer that is ID of the shift during which the item was consumed.
shift_desc	A string that is the description of the shift during which the item was consumed, from the Shift table.
grade_cd	An integer that is the grade code of the consumed goods.
item_grade_desc	A string that is the grade description, from the Item_Grade table.
grade_color	An integer that is RGB background color of the grade, from the Item_Grade table.
status_cd	An integer that is the status code of the consumed goods.
item_status_desc	A string that is the status description, from the Item_State table.
status_color	An integer that is RGB background color of the item state, from the Item_State table.
from_ent_id	An integer that is ID of the storage entity from which the item was consumed.
from_ent_name	A string that is name of the storage entity from which the item was consumed, from the Ent table
qty_cons	A double that is the quantity consumed.
qty_cons_erp	A double that is the quantity consumed value that was reported to an ERP system.
ext_ref	A string that is the reference to an external system for defect tracking or any other purpose.
transaction_type	An integer that is the transaction type enumerated value. 0 = normal 1 = lot split 2 = combination
genealogy_id	A string that is the genealogy ID.
upstream_event_id	A string that is the upstream 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 consumption.
spare1 – spare4	Strings that are the contents of the user-defined spare1 through spare4 fields.
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.

Returns a DataSet that contains all the records in the Item_Cons 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.

MES Stateless API