MES Stateless API

GetByFilter(String,String,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,ParentEnt[]) Method

Save PDF

TABLE OF CONTENTS

GetByFilter(String,String,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,Nullable<Boolean>,ParentEnt[]) Method

Save PDF

Last UpdatedMar 17, 2026
7 minute read

The GetByFilter() method retrieves a set of entity records based on the input filters.

This overload of the method includes the getUnlisted input parameter.

Syntax

'Declaration
 
Public Overloads Shared Function GetByFilter( _
   ByVal entName As String, _
   ByVal description As String, _
   ByVal canSchedJobs As Nullable(Of Boolean), _
   ByVal canRunJobs As Nullable(Of Boolean), _
   ByVal canCaptureUtil As Nullable(Of Boolean), _
   ByVal canCaptureLabor As Nullable(Of Boolean), _
   ByVal canDoDNC As Nullable(Of Boolean), _
   ByVal canTrackOEE As Nullable(Of Boolean), _
   ByVal canSchedShifts As Nullable(Of Boolean), _
   ByVal canStore As Nullable(Of Boolean), _
   ByVal canLogData As Nullable(Of Boolean), _
   ByVal canShip As Nullable(Of Boolean), _
   ByVal canReceive As Nullable(Of Boolean), _
   ByVal canCopyFolders As Nullable(Of Boolean), _
   ByVal canCaptureQmData As Nullable(Of Boolean), _
   ByVal canEntClass As Nullable(Of Boolean), _
   ByVal getUnlisted As Nullable(Of Boolean), _
   ByVal parentEntList() As ParentEnt _
) As DataSet

'Usage
 
Dim entName As String
Dim description As String
Dim canSchedJobs As Nullable(Of Boolean)
Dim canRunJobs As Nullable(Of Boolean)
Dim canCaptureUtil As Nullable(Of Boolean)
Dim canCaptureLabor As Nullable(Of Boolean)
Dim canDoDNC As Nullable(Of Boolean)
Dim canTrackOEE As Nullable(Of Boolean)
Dim canSchedShifts As Nullable(Of Boolean)
Dim canStore As Nullable(Of Boolean)
Dim canLogData As Nullable(Of Boolean)
Dim canShip As Nullable(Of Boolean)
Dim canReceive As Nullable(Of Boolean)
Dim canCopyFolders As Nullable(Of Boolean)
Dim canCaptureQmData As Nullable(Of Boolean)
Dim canEntClass As Nullable(Of Boolean)
Dim getUnlisted As Nullable(Of Boolean)
Dim parentEntList() As ParentEnt
Dim value As DataSet
 
value = Ent.GetByFilter(entName, description, canSchedJobs, canRunJobs, canCaptureUtil, canCaptureLabor, canDoDNC, canTrackOEE, canSchedShifts, canStore, canLogData, canShip, canReceive, canCopyFolders, canCaptureQmData, canEntClass, getUnlisted, parentEntList)

public static DataSet GetByFilter( 
   string entName,
   string description,
   Nullable<bool> canSchedJobs,
   Nullable<bool> canRunJobs,
   Nullable<bool> canCaptureUtil,
   Nullable<bool> canCaptureLabor,
   Nullable<bool> canDoDNC,
   Nullable<bool> canTrackOEE,
   Nullable<bool> canSchedShifts,
   Nullable<bool> canStore,
   Nullable<bool> canLogData,
   Nullable<bool> canShip,
   Nullable<bool> canReceive,
   Nullable<bool> canCopyFolders,
   Nullable<bool> canCaptureQmData,
   Nullable<bool> canEntClass,
   Nullable<bool> getUnlisted,
   ParentEnt[] parentEntList
)

Parameters

entName: Optional filter parameter. Holds an entity name.
description: Optional filter parameter. Holds an entity description.
canSchedJobs: Optional filter parameter. Holds the flag that specifies whether jobs can be scheduled to an entity.
canRunJobs: Optional filter parameter. Holds the flag that specifies whether jobs can be run on an entity.
canCaptureUtil: Optional filter parameter. Holds the flag that specifies whether utilization data can be captured on an entity.
canCaptureLabor: Optional filter parameter. Holds the flag that specifies whether labor data be captured on an entity.
canDoDNC: Optional filter parameter. Not used. Will always be set to False.
canTrackOEE: Optional filter parameter. Holds the flag that specifies whether OEE statistics can be captured on an entity.
canSchedShifts: Optional filter parameter. Holds the flag that specifies whether shifts can be scheduled for an entity.
canStore: Optional filter parameter. Holds the flag that specifies whether an entity can be a “warehouse” or storage location.
canLogData: Optional filter parameter. Holds the flag that specifies whether an entity can log data.
canShip: Optional filter parameter. Holds the flag that specifies whether shipments can be made from an entity.
canReceive: Optional filter parameter. Holds the flag that specifies whether material can be received at an entity.
canCopyFolders: Optional filter parameter. Holds the flag that specifies whether files in folders for an entity can be copied to its download directories.
canCaptureQmData: Optional filter parameter. Holds the flag that specifies whether QM data can be captured on an entity.
canEntClass: Optional filter parameter. Holds the flag that specifies whether an entity can be an entity class.
getUnlisted: Optional filter parameter. Holds the flag that specifies whether unlisted entities can be an filtered.
parentEntList: Optional filter parameter. Holds an array of ParentEnt objects, each containing the fields needed to filter the entities.

Return Value

Returns a DataSet that contains a DataRow for each entity record that satisfies the specified filter criteria. Column values are from the Ent, table unless otherwise indicated. If no matching record is found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

Column Names	Description
ent_id	An integer that is the ID of the entity.
ent_name	A string that is the name of the entity.
description	A string that is the description of the entity.
parent_ent_id	An integer that is the default preferred parent entity ID, null for a top-level entity. If an entity has multiple parents, this is the parent entity from which will inherit elements that can only be inherited from one parent entity (e.g., shift schedule).
site	An integer that is the ID of the ancestor entity that defines the site of the current identified entity.
site_name	A string that is the site name of the entity, from the Site table
hourly_cost	A double that is the hourly cost of running this entity.
can_sched_jobs	A Boolean flag that indicates whether jobs can be scheduled to this entity.
can_run_jobs	A Boolean flag that indicates whether jobs can be run on this entity.
can_capture_util	A Boolean flag that indicates whether utilization data can be captured on this entity.
can_capture_labor	A Boolean flag that indicates whether labor data can be captured on this entity.
can_do_dnc	Not used. Will always return False.
can_track_oee	A Boolean flag that indicates whether OEE statistics can be captured on this entity.
can_sched_shifts	A Boolean flag that indicates whether shifts can be scheduled for this entity.
can_store	A Boolean flag that indicates whether this entity can be a storage location, such as a warehouse.
can_log_data	A Boolean flag that indicates whether this entity can log data.
can_ship	A Boolean flag that indicates whether shipments can be made from this entity.
can_receive	A Boolean flag that indicates whether material can be received at this entity.
can_copy_folders	A Boolean flag that indicates whether files in folders for this entity can be copied to its download directories.
can_capture_qm_data	A Boolean flag that indicates whether this entity can capture QM data and have sample requests generated for it.
can_sched_jobs_from_galaxy	If the entity originated from a System Platform galaxy, a Boolean flag that indicates whether jobs can be scheduled to this entity.
can_run_jobs_from_galaxy	If the entity originated from a System Platform galaxy, a Boolean flag that indicates whether jobs can be run on this entity.
can_capture_util_from_galaxy	If the entity originated from a System Platform galaxy, a Boolean flag that indicates whether utilization data can be captured on this entity.
can_track_oee_from_galaxy	If the entity originated from a System Platform galaxy, a Boolean flag that indicates whether OEE statistics can be captured on this entity.
can_store_from_galaxy	If the entity originated from a System Platform galaxy, a Boolean flag that indicates whether this entity can be a storage location, such as a warehouse.
entity_from_galaxy	A Boolean flag that indicates whether this entity originated from a System Platform galaxy.
cur_shift_id	An integer that is the current shift ID on this entity.
cur_shift_start_time_utc	A datetime that is the current shift start time for this entity in UTC.
cur_shift_start_time_local	A datetime that is the current shift start time for this entity in local time.
shift_desc	A string that is the shift description, from the Shift table
last_domain_change	A datetime that is the date/time when the domain last changed.
tree_icon	A string that is the key for retrieving the hierarchy tree icon image from the Graphics table. Not currently implemented
flow_diag_img	A string that is the key for retrieving the flow diagram image from the Graphics table. Not currently implemented
identical_job_execs	An integer that is the maximum number of jobs that can be run at the same time on this entity.
show_in_dsp_tree	A Boolean flag that indicates whether this entity appears in the data source plug-in tree.
ent_class	A Boolean that is a flag that indicates whether this object is an entity class.
spare1	A string that is the contents of the spare1 field.
spare2	A string that is the contents of the spare2 field.
spare3	A string that is the contents of the spare3 field.
spare4	A string that is the contents of the spare4 field.
last_edit_comment	A string that is the comment about why the record was added or changed.
last_edit_by	A string that is the user ID of the user who added or last edited this record.
last_edit_at	A datetime that identifies when the record was added or last modified.
parent_ent_id	An integer that is the ID of the default preferred parent entity, null for a top-level entity. If an entity has multiple parents, this is the parent entity from which it will inherit elements that can only be inherited from one parent entity (e.g., shift schedule).
parent_ent_name	A string that is the name of the default preferred parent entity, null for a top-level entity. If an entity has multiple parents, this is the parent entity from which it will inherit elements that can only be inherited from one parent entity (e.g., shift schedule).
child_level	A string that the entity’s level in the entity hierarchy. For example, 1 represents the top level entity, which does not have any parent; 2 represents the first child level; 3 represents the second child level; and so on.
ent_tree	A list of ancestor entities, from the topmost entity but excluding this entity, separated by hyphen. For example, 1-101-1001 represents 1 being the topmost entity, 101 represents the child for 1, and 1001 represents the child for 101, and 1001 represents the parent entity for this entity.
exact_match	The indication whether the entity can run jobs, can capture utilization, can track OEE, have only one job position, are not linked to any line (as parents or children), have a non-null default production rate, and matches the filter criteria. Entities for which this property is true are eligible to be added to a line.

MES Stateless API

Table of Contents

In This Topic

MES Stateless API

Syntax

Parameters

Return Value

Remarks

See Also

Reference

In This Topic