MES Stateless API

GetAll(Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Boolean>,String,String,String,String,String,Nullable<DateTime>,Nullable<Boolean>) Method

Save PDF

GetAll(Nullable<Int32>,Nullable<Int32>,Nullable<Int32>,Nullable<Boolean>,String,String,String,String,String,Nullable<DateTime>,Nullable<Boolean>) Method

Save PDF

Last UpdatedNov 06, 2025
5 minute read

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

This overload of the method includes the getCurrentUtil parameter.

Syntax

'Declaration
 
Public Overloads Shared Function GetAll( _
   ByVal entId As Nullable(Of Integer), _
   ByVal curStateCd As Nullable(Of Integer), _
   ByVal curReasCd As Nullable(Of Integer), _
   ByVal reasReqd As Nullable(Of Boolean), _
   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), _
   ByVal getCurrentUtil As Nullable(Of Boolean) _
) As DataSet

'Usage
 
Dim entId As Nullable(Of Integer)
Dim curStateCd As Nullable(Of Integer)
Dim curReasCd As Nullable(Of Integer)
Dim reasReqd As Nullable(Of Boolean)
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 getCurrentUtil As Nullable(Of Boolean)
Dim value As DataSet
 
value = UtilExec.GetAll(entId, curStateCd, curReasCd, reasReqd, spare1, spare2, spare3, spare4, lastEditBy, lastEditAt, getCurrentUtil)

public static DataSet GetAll( 
   Nullable<int> entId,
   Nullable<int> curStateCd,
   Nullable<int> curReasCd,
   Nullable<bool> reasReqd,
   string spare1,
   string spare2,
   string spare3,
   string spare4,
   string lastEditBy,
   Nullable<DateTime> lastEditAt,
   Nullable<bool> getCurrentUtil
)

Parameters

entId: Optional filter parameter. Holds the ID of the entity whose utilization exec records are being retrieved.
curStateCd: Optional filter parameter. Holds a current utilization state code.
curReasCd: Optional filter parameter. Holds a current reason code.
reasReqd: Optional filter parameter. Holds a flag that indicates whether the machine requires a final reason.
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.
lastEditBy: Optional filter parameter. Holds a user who added or last changed a utilization exec record.
lastEditAt: Optional filter parameter. Holds the date/time when a utilization exec record was added or last edited.
getCurrentUtil: Optional filter parameter. Holds a flag that, if set to false, specificies that the system will not be triggered to calculate the current utilization value. Defaults to true.

Return Value

Returns a DataSet that contains the records in the Util_Exec 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
ent_id	An integer that is the ID of the entity that is capturing utilization.
ent_name	A string that is the entity name from ent.ent_name column linked to this record.
cur_state_cd	An integer that is the current utilization state for the entity.
state_desc	A string that is the description of the current utilization state, from the util_state.state_desc column linked to this cur_state_cd.
color	An integer that is the background color for this state description when displayed in the user interface.
cur_reas_cd	An integer that is the current utilization reason code for the entity.
reas_desc	A string that is the description for the utilization reason, from the util_reas.reas_desc column linked to this cur_reas_cd for this Util_Exec row.
cur_reas_start_utc	A datetime that is the current reason start time, in UTC.
cur_reas_start_local	A datetime that is the current reason start time, in the local time of the entity.
cur_reas_start	A datetime that is the current reason start time, in the local time of the client application that is making the call.
cur_raw_reas_cd	A string that is the raw reason code from PLC. Set to null if there is no raw reason code assigned to the entity.
reas_reqd	A Boolean that is a flag that indicates whether the machine requires a final reason or not.
cur_log_id	An integer that is the current utilization log_id (util_history.log_id). Beginning with MES version 6.0, this column is not used for new records.
target_util	A floating point number that is the target utilization for the entity.
current_util	A floating point number that is the current utilization for the entity.
jobstart_reas_cd	An integer that is the job start reason code.
jobstart_reas_desc	A string that is the description for the job end utilization reason, from the util_reas.reas_desc column linking the jobstart_reas_cd for the entity.
jobend_reas_cd	An integer that is the job end reason code.
jobend_reas_desc	A string that is the description for the job end utilization reason, from the util_reas.reas_desc column linking the jobend_reas_cd for the entity.
shift_start_reas_cd	An integer that is the shift start reason code.
shift_start_reas_desc	A string that is the description for the shift start utilization reason from util_reas.reas_desc column linking the shift_start_reas_cd for the entity.
shift_end_reas_cd	An integer that is the shift end reason code.
shift_end_reas_desc	A string that is the description for the shift end reason, the from util_reas.reas_desc column linking the shift_end_reas_cd for the entity.
unkn_stop_reas_cd	An integer that is the unknown stop reason code.
unkn_stop_reas_desc	A string that is the description for the unknown stop reason, from the util_reas.reas_desc column linking the unkn_stop_reas_cd for the entity.
break_start_reas_cd	An integer that is the break start reason code.
break_start_reas_desc	A string that is the description for the break start reason, from the util_reas.reas_desc column linking the break_start_reas_cd for the entity.
break_end_reas_cd	An integer that is the break end reason code.
break_end_reas_desc	A string that is the description for the break end reason, from the util_reas.reas_desc column linking the break_end_reas_cd for the entity.
inherit_from_parent	A Boolean that is a flag that indicates whether a change in cur_reas_cd for a parent entity should be applied to the entity or not.
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.
cur_reas_duration	A string that is the current reason duration, in ‘hh:mi:ss’ format.
last_edit_comment	A string that contains comments about why the record was added or last changed.
last_edit_by	A string that is the user who last edited this record is returned.
last_edit_at	A datetime that specifies the record was created or last modified.

MES Stateless API