MES Stateless API

GetAll Method (SamplePlanFreqLink)

Save PDF

GetAll Method (SamplePlanFreqLink)

Save PDF

Last UpdatedNov 06, 2025
3 minute read

The GetAll() method retrieves one or more sample plan frequency link records from the Sample_Plan_Freq_Link table, as specified by the filter parameters. Passing no filter parameters will retrieve all sample plan frequency link records from the table.

Syntax

'Declaration
 
Public Shared Function GetAll( _
   ByVal planId As Nullable(Of Integer), _
   ByVal freqId As Nullable(Of Integer), _
   ByVal lastEditBy As String, _
   ByVal lastEditAt As Nullable(Of Date) _
) As DataSet

'Usage
 
Dim planId As Nullable(Of Integer)
Dim freqId As Nullable(Of Integer)
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = SamplePlanFreqLink.GetAll(planId, freqId, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   Nullable<int> planId,
   Nullable<int> freqId,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

planId: Optional filter parameter. Holds the ID of the sample plan linked.
freqId: Optional filter parameter. Holds the ID of the sample plan frequency linked.
lastEditBy: Optional filter parameter. Holds the ID of a user who added or last updated a sample plan record.
lastEditAt: Optional filter parameter. Holds the date/time when a sample plan record was added or last updated.

Return Value

Returns a DataSet that contains all the records in the Sample_Plan_Freq_Link table that satisfy the specified filters. If no matching records are found, an empty DataSet is returned. All columns are from the Sample_Plan_Freq_Link table unless otherwise indicated.

The columns of the returned DataSet are described below.

Column Name	Description
plan_id	An integer that is the ID of the sample plan.
plan_name	A string that is the name of the sample plan. From the Sample Plan table.
freq_id	An integer that is the ID of the sample plan frequency.
freq_name	A string that is the name of the sample plan frequency. From the Sample_Freq table.
freq_desc	A string that is the description of the sample plan frequency. From the Sample_Freq table.
freq_type	An integer which defines the type of sample plan frequency. From the Sample_Freq table. 0 = shift 1 = calendar time (the default) 2 = run time 3 = production 4 = main item produced changes (job_bom.current_subst for bom_pos = 0) 5 = item consumed at any BOM position changes 6 = the lot number of the main item produced changes (job_bom.def_lot_no for bom_pos = 0) 7 = the lot number of an item consumed at any BOM position changes 8 = the job changes 9 = utilization changes from runtime to downtime 10 = utilization changes from runtime to idle time 11 = utilization changes from downtime to runtime 12 = utilization changes from downtime to idle time 13 = utilization changes from idle time to runtime 14 = utilization changes from idle time to downtime 15 = inventory is received 16 = a new specification value is downloaded for the job running on a job position 17 = a step with action_type 6 starts 18 = a step with action_type 6 finishes
last_edit_comment	A string that contains comments about why the record was updated.
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.
row_id	An integer that is the row ID of the link record from the Sample_Plan_Freq_Link table.

MES Stateless API