MES Stateless API

GetEnts Method

Save PDF

GetEnts Method

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetEnts() method retrieves a list of entities that the user has logged on to, from the Ent_Logon table.

Syntax

'Declaration
 
Public Shared Function GetEnts( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal startTime As Date _
) As DataSet

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim startTime As Date
Dim value As DataSet
 
value = Session.GetEnts(sessionId, userId, startTime)

public static DataSet GetEnts( 
   int sessionId,
   string userId,
   DateTime startTime
)

Parameters

sessionId

Required. Holds the session ID and thus the user who is making this method call.

userId

Required. Holds the ID of the user whose logged on to entities are being retrieved.

startTime

Required. Holds a date/time that identifies a session start time by which to filter the entities that are being retrieved. If a time is provided, only those entities that the user has logged on to after the specified start time are retrieved.

To not include this parameter as a filter, pass a null.

Return Value

Returns a DataSet that contains the records from the Ent_Logon table that correspond to the entities that the specified user has logged on to and, optionally, after the specified session start time. 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, from the Ent_Logon table.
ent_name	A string that contains the name of the entity, from the ent.ent_name column linked to this Ent_Logon record.
description	A string that contains the description of the entity, from the ent.description column linked to this Ent_Logon record.
parent_ent_id	An integer that is the ID of the parent entity, from the ent.parent_ent_id column for this entity linked to the Ent_Logon record.
site	An integer that is the ID of ancestor entity that defines the site of this entity.
site_name	A string that contains the name of the site, from the site.site_name column linked to this entity.
hourly_cost	A double that is the cost of running of this entity.
can_sched_jobs	A Boolean that is a flag that indicates whether this entity can schedule jobs.
can_run_jobs	A Boolean that is a flag that indicates whether this entity can run jobs.
can_capture_util	A Boolean that is a flag that indicates whether this entity can capture utilization.
can_capture_labor	A Boolean that is a flag that indicates whether this entity can capture labor.
can_do_dnc	Not used. Will always return False.
can_track_oee	A Boolean that is a flag that indicates whether this entity can track OEE statistics.
can_sched_shifts	A Boolean that is a flag that indicates whether this entity can schedule shifts.
can_store	A Boolean that is a flag that indicates whether this entity can store items.
can_log_data	A Boolean that is a flag that indicates whether this entity can log data.
can_ship	A Boolean that is a flag that indicates whether this entity can ship items.
can_receive	A Boolean that is a flag that indicates whether this entity can receive materials.
can_copy_folders	A Boolean that is a flag that indicates whether this entity can copy files to its download directories.
cur_shift_id	An integer that is the ID of the current shift running on this entity.
cur_shift_start_time_utc	A date/time that is the shift start time in UTC.
cur_shift_start_time_local	A date/time that is the shift start time in the local time of the entity.
cur_shift_start_time	A date/time that is the shift start time in the local time of the client application that is making the call.
shift_desc	A string that is the description of the shift, from the shift.shift_desc column linked to this cur_shift_id.
last_domain_change	Unused.
tree_icon	A string that contains the graphic icon/image ID used for this entity tree
flow_diag_img	A string that contains the graphic to use for the flow diagram image.
identical_Job_Execs	An integer that is the number of identical ‘positions’ that can run independent jobs on this entity.
show_in_dsp_tree	A Boolean that is a flag that indicates whether this entity should appear in the data source plug-in tree.
spare1	A string that is the contents of the user-defined spare1 field.
spare2	A string that is the contents of the user-defined spare2 field.
spare3	A string that is the contents of the user-defined spare3 field.
spare4	A string that is the contents of the user-defined spare4 field.
last_edit_comment	A string that contains comments about why the record was added or updated.
last_edit_by	A string that is the ID of the user who added or last updated this record.
last_edit_at	A date/time value that indicates when the record was created or last modified.

MES Stateless API

GetEnts Method

Table of Contents

GetEnts Method

In This Topic

MES Stateless API

GetEnts Method

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic