MES Stateless API

GetByKey Method (UtilState)

Save PDF

GetByKey Method (UtilState)

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetByKey() method retrieves one utilization state record from the Util_State table, as specified by the filter parameters.

Syntax

'Declaration
 
Public Shared Function GetByKey( _
   ByVal stateCd As Integer _
) As DataSet

'Usage
 
Dim stateCd As Integer
Dim value As DataSet
 
value = UtilState.GetByKey(stateCd)

public static DataSet GetByKey( 
   int stateCd
)

Parameters

stateCd: Required filter parameter. Holds the code that identifies the utilization state to be retrieved.

Return Value

Returns a DataSet that contains the record in the Util_State table that matches the specified utilization state code. If no matching record is found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
state_cd	An integer that is the code for the utilization state.
state_desc	A string that is the description of the utilization state.
color	An integer that indicates the RGB background color for this state description when displayed in the user interface.
runtime	This state's default utilization reason setting for a Boolean flag that indicates whether the utilization reason is used for runtime.
downtime	This state's default utilization reason setting for a Boolean flag that indicates whether the utilization reason is used for downtime.
setuptime	This state's default utilization reason setting for a Boolean flag that indicates whether the utilization reason is used for setup time.
teardowntime	This state's default utilization reason setting for a Boolean flag that indicates whether the utilization reason is used for teardown time.
fixedtime	This state's default utilization reason setting for a Boolean flag that indicates whether this utilization reason is used for fixed time.
vartime	This state's default utilization reason setting for a Boolean flag that indicates whether this utilization reason is used for variable time.
failure	This state's default utilization reason setting for a Boolean flag that indicates whether any time that the entity spends in the utilization reason code is considered failure time.
def_lab_cd	This state's default utilization reason setting for a string that is the default labor code for the utilization reason when it is manually selected.
priority	This state's default utilization reason setting for an integer that is the priority of the utilization reason, which is used to determine the reason for a line that has two or more bottleneck entities with differing reasons.
max_duration	An integer that is the maximum duration, in seconds, that the utilization reason is not considered to be in a severe condition or before the reason is changed to a new utilization reason code. If the New Reason Code parameter is not being used (that is, it is null) and the maximum duration is exceeded, the reason is marked as being Severe and the event is considered to be in a severe condition. The Severe flag is typically used with downtime events. If the New Reason Code parameter is being used and the maximum duration is exceeded, the utilization reason for the entity is changed to the new reason specified in the New Reason Code parameter.
new_reas_cd	This state's default utilization reason setting for an integer that specifies the utilization reason to which the reason should change when the maximum duration is exceeded.
standard_time	This state's default utilization reason setting for a double that specifies the standard amount of time, in minutes, that an entity is expected to be in the utilization reason.
min_time	This state's default utilization reason setting for a double that specifies the minimum amount of time, in minutes, that an entity is expected to be in the utilization reason.
max_time	This state's default utilization reason setting for a double that specifies the maximum amount of time, in minutes, that an entity is expected to be in the utilization reason.
ent_enabled	This state's default utilization reason setting for a Boolean flag that indicates whether an entity in this utilization reason is to be considered enabled.
category1	This state's default utilization reason entry for a string that is the content of the category1 field.
category2	This state's default utilization reason entry for a string that is the content of the category2 field.
category3	This state's default utilization reason entry for a string that is the content of the category3 field.
category4	This state's default utilization reason entry for a string that is the content of the category4 field.
last_edit_comment	A string that contains comments about why the record was added or changed.
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 specifies when the record was added or last updated.

MES Stateless API

GetByKey Method (UtilState)

Table of Contents

GetByKey Method (UtilState)

In This Topic

MES Stateless API

GetByKey Method (UtilState)

Syntax

Parameters

Return Value

See Also

Reference

In This Topic