MES Stateless API

GetGroups(Nullable<Int32>) Method

Save PDF

GetGroups(Nullable<Int32>) Method

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The GetGroups() method retrieves all data log groups records in the Data_Log_Grp table, optionally filtered by an entity. If an entity is specified and it is not assigned to a data log group, then all data log groups that are not assigned to any entity are included in the returned DataSet.

In this overload of the method, the entity is identified by its entity ID.

Syntax

'Declaration
 
Public Overloads Shared Function GetGroups( _
   ByVal entId As Nullable(Of Integer) _
) As DataSet

'Usage
 
Dim entId As Nullable(Of Integer)
Dim value As DataSet
 
value = DataLogGrp.GetGroups(entId)

public static DataSet GetGroups( 
   Nullable<int> entId
)

Parameters

entId: Optional filter parameter. Holds the ID of an entity. To not include this parameter as a filter, pass a null.

Return Value

Returns a DataSet that contains all the records in the Data_Log_Grp table, optionally filtered by an entity. If an entity is specified and it is not assigned to a data log group, then all data log groups that are not assigned to any entity are included in the returned DataSet. If no matching records are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Name	Description
grp_id	An integer that is the unique ID of the data log group.
grp_desc	A string that is the description of the data log group.
ent_id	An integer value from the Data_Log_Grp_Ent_Link.ent_id column linking this data log group.
ent_name	A string that is the entity name from the ent.ent_name column linking the Data_Log_Grp_Ent_Link.ent_id column for this data log group.
max_value	An integer that is the maximum of number of sample values that can be collected for the data log group. Beginning with MES 7.0, this field is not used by the system. For new Data_Log_Group records, it defaults to 64.
trigger_type	An integer that is the enumeration of the trigger type that triggers data collection. Currently, only the manual trigger type (0) is supported by the system.
trigger_detail	A string that is the XML-encoded detail for the trigger, which depends on the trigger type. Because this parameter does not apply to the manual trigger type, it is not currently used by the system.
obsolete	A Boolean that is a flag that indicates whether this data log group is obsolete or not.
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 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 indicates when the record was added or last updated.
mod_id	The current modification ID of the record in the table. This ID is binary number that increments each time the record’s table row is modified. Optionally used for optimistic concurrency control when performing updates or deletes.

MES Stateless API