MES Stateless API

GetItemRunOnALine Method

Save PDF

GetItemRunOnALine Method

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetItemRunOnALine() method returns a DataSet that contains the items that were produced on a line during a specified period of time.

Syntax

'Declaration
 
Public Shared Function GetItemRunOnALine( _
   ByVal lineId As Integer, _
   ByVal filterType As LineFilterType, _
   ByVal filterDuration As Nullable(Of Integer), _
   ByVal filterTimeUnit As LineFilterTimeUnit, _
   ByVal filterStartOffset As Nullable(Of Integer), _
   ByVal filterEndOffset As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim lineId As Integer
Dim filterType As LineFilterType
Dim filterDuration As Nullable(Of Integer)
Dim filterTimeUnit As LineFilterTimeUnit
Dim filterStartOffset As Nullable(Of Integer)
Dim filterEndOffset As Nullable(Of Integer)
Dim value As DataSet
 
value = Line.GetItemRunOnALine(lineId, filterType, filterDuration, filterTimeUnit, filterStartOffset, filterEndOffset)

public static DataSet GetItemRunOnALine( 
   int lineId,
   LineFilterType filterType,
   Nullable<int> filterDuration,
   LineFilterTimeUnit filterTimeUnit,
   Nullable<int> filterStartOffset,
   Nullable<int> filterEndOffset
)

Parameters

lineId

Required. Holds the ID of the line.

filterType

Required. Holds a LineFilterType enumeration value that specifies the type of time period by which to filter the data. For more information, see the LineFilterType enumeration help topic for the FactMES.API.Core namespace.

filterDuration

Optional. Holds an integer value that specifies the value of N if filterType is LastNHours.

filterTimeUnit

Required. Holds a LineFilterTimeUnit enumeration value that specifies the time unit for a custom filter if filterType is Custom. For more information, see the LineFilterTimeUnit enumeration help topic for the FactMES.API.Core namespace.

If filterType is not Custom, this parameter is ignored.

filterStartOffset

Optional. Holds an integer that specifies the start point of the time interval for which the events are to be filtered. See the Remarks section below for more information about how this parameter is used.

filterEndOffset

Optional. Holds an integer that specifies the end point of the time interval for which the events are to be filtered. See the Remarks section below for more information about how this parameter is used.

Return Value

Returns a DataSet that contains the items that were produced on the line during the specified period of time.

The columns of the returned DataSet are described below.

Column Name	Description
item_id	A string that is the ID of the item.
item_desc	A string that is the description of the item.
item_display	A string that is the display string for the item that is returned. The display string is based on the Item Display system attribute (attr_id = 210). If the value of the system attribute is 0, the display string has the following format: item_id. If the value of the system attribute is 1, the display string has the following format: item_desc. If the value of the system attribute is 2, the display string has the following format: item_id (item_desc). If the value of the system attribute is 3, the display string has the following format: item_desc (item_id).
uom_description	A string that is the description of the unit of measure, from the UOM table.
uom_abbreviation	A string that is the abbreviation of the unit of measure, from the UOM table.
num_decimals	An integer that is the number of decimals for formatting the period_produced and period_rejected values.
period_produced	A double that is the quantity of good production made on the production entities of the line during the specified time period, in terms of the UOM of the line's standard item if defined. From the Job table.
period_rejected	A double that is the quantity of rejected production made on the entities upstream from and including the production entities of the line during the specified time period, in terms of the UOM of the line's standard item if defined. From the Job table.

MES Stateless API