MES Stateless API

GetStatusInfo Method

Save PDF

GetStatusInfo Method

Save PDF

Last UpdatedMar 17, 2026
5 minute read

The GetStatusInfo() method retrieves the current status information for the specified entity and, optionally, its child entities.

Syntax

'Declaration
 
Public Shared Function GetStatusInfo( _
   ByVal entId As Integer, _
   ByVal childLevels As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim entId As Integer
Dim childLevels As Nullable(Of Integer)
Dim value As DataSet
 
value = Ent.GetStatusInfo(entId, childLevels)

public static DataSet GetStatusInfo( 
   int entId,
   Nullable<int> childLevels
)

Parameters

entId

Required. Holds the ID of the entity whose status information is being retrieved.

childLevels

Optional. Holds the number of child levels of the specified entity to include in the status information that is returned.

To return status information for just the supplied entity, pass either 0 or null.

To return status information for the supplied entity and its descendants to a specified level, pass an integer value greater than 0. For example, a value of 1 would return the status of the entity and its immediate descendants. A value of 2 would return the status of the entity, its children, and the immediate descendants of those children.

Return Value

Returns a DataSet that includes the status information for the entity and, if specified, the child entities.

The columns of the returned DataSet are described below.

Column Names	Description
ent_id	An integer that is the ID of the specified entity, from the Ent table.
ent_name	A string that is the entity name, from the Ent table.
cur_shift_id	An integer data type that is the current shift on the given entity, from the Ent table.
shift_desc	A string that is the shift description, from the Shift table. The value is null if the shift was deleted.
cur_shift_start_time_utc	A datetime that identifies the current shift start time for this entity in UTC, from the Ent table.
cur_shift_start_time_local	A datetime that identifies when the current shift start time for this entity in local time, from the Ent table.
tree_icon	A string that is the key for retrieving the hierarchy tree icon image from the Graphics table. Not currently implemented
job_pos	An integer that is the numbers of jobs that run can concurrently on the given entity, from Job_Exec table. Returns 0 when only a single job can run on the entity at a time.
cur_wo_id	A string that is the current work order on the given entity, from Job_Exec table.
cur_oper_id	A string that is the current operation on this entity, from Job_Exec table.
cur_seq_no	An integer that is the current operation split, from Job_Exec table.
cur_step_no	An integer that is the last step started on a given entity, from Job_Exec table. A null is returned if steps are not being used.
spare1	A string that is the spare1 entry, from the Job_Exec table.
spare2	A string that is the spare2 entry, from the Job_Exec table.
spare3	A string that is the spare3 entry, from the Job_Exec table.
spare4	A string that is the spare4 entry, from the Job_Exec table.
job_state_cd	An integer that is the state ID, from the Job table.
target_perf	A double that is the target performance value, from the Oee_Exec table.
current_perf	A double that is the current performance value, from the Oee_Exec table.
target_qual	A double that is the target quality value, from the Oee_Exec table.
current_qual	A double that is the current quality value, from the Oee_Exec table.
target_oee	A double that is the target OEE, from the Oee_Exec table.
current_oee	A double that is the current OEE, from the Oee_Exec table.
mo_id	A string that is the manufacturing order, for grouping different final parts, from the WO table.
cust_info	A string that is the customer information for a given work order, from the WO table.
item_id	A string that is the item resulting from given job, from the Job table.
item_display	A string that is the display string for the item which 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).
job_priority	An integer that is the operation priority, from the Job table.
uom_id	An integer that is the ID of the unit of measure. If the job uom ID is non-null, then this value comes from the Job table; otherwise, this value comes from the Item table.
uom_desc	A string that is the description of the unit of measure, from the Uom table.
uom_abbr	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 numeric values.
num_decimals_good_pp	An integer that is the value of the system_attr 326 Max decimals of good piece part entries and is used when the 'num_decimals' column is zero.
req_finish_time_utc	A datetime that identifies the required completion date/time in UTC , from the Job table.
req_finish_time_local	A datetime that identifies the required completion date/time in local time, from the Job table.
qty_reqd	A double that is the quantity of item required, from the Job table.
qty_prod	A double that is the quantity of item made so far, from the Job table.
qty_rejected	A double that is the quantity of item rejected so far, from the Job table.
qty_at_start	A double that is the quantity of item that is expected to be produced if there are no scrap/waste/rejects, from the Job table.
sched_start_time_utc	A datetime that identifies the scheduled start time in UTC, from the Job table.
sched_start_time_local	A datetime that identifies the scheduled start time in local time, from the Job table.
sched_finish_time_utc	A datetime that identifies the estimated completion time in UTC, from the Job table.
sched_finish_time_local	A datetime that identifies the estimated completion time in local time, from the Job table.
cur_state_cd	An integer that is the current state of the given entity, from the Util_Exec table.
cur_reas_cd	An integer that is the current reason for the given entity, from the Util_Exec table.
target_util	A double that is the target entity utilization, from the Util_Exec table.
current_util	A double that is the current entity utilization = RT/(RT+DT), from the Util_Exec table.
cur_reas_start_utc	A datetime that identifies when the current entity reason started in UTC, from Util_Exec table.
cur_reas_start_local	A datetime that identifies when the current entity reason started in local time, from Util_Exec table.
qty_to_do	A double that is the quantity of item still required to be made (qty_reqd - qty_prod).
qty_remaining	A double that is the quantity defined as the difference between the start quantity and the sum of the quantity produced and the quantity rejected (qty_start - (qty_prod + quantity rejected)).

MES Stateless API