MES Stateful API

GetInventoryData Method

Save PDF

GetInventoryData Method

Save PDF

Last UpdatedNov 06, 2025
1 minute read

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

If the restrictToEnt is set, then the record set contains inventory records for only the specified entity is retrieved. If the restrictToEnt is cleared, the record set contains inventory records for the specified entity and all other storage entities located at the specfied entity are retrieved. The record set can be further filter by passing a filter string with the following syntax: item_id=lot_no=item_grade_cd=item_status_cd=. If one or more item grades or statuses are supplied, they must be in a comma separated list enclosed in parenthesis.

Syntax

'Declaration
 
Public Shared Function GetInventoryData( _
   ByVal entID As Integer, _
   ByVal restrictToEnt As Boolean, _
   ByVal filtr As String _
) As DataSet

public static DataSet GetInventoryData( 
   int entID,
   bool restrictToEnt,
   string filtr
)

Parameters

entID: Required. Holds the ID of the entity for which to get inventory.
restrictToEnt: Required. Holds a flag which indicates whether the inventory will only be for the specified entity.
filtr: Required. Holds a filter string with the format described above.

Return Value

Returns a DataSet that contains all the records in the Item_Inv 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 Stateful API