MES Stateless API

GetAll Method (JobState)

Save PDF

GetAll Method (JobState)

Save PDF

Last UpdatedNov 06, 2025
2 minute read

The GetAll() method retrieves job and step state records from the Job_State table, as specified by the filter parameters. Passing no filter parameters will retrieve all job and step state records from the table.

Syntax

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

'Usage
 
Dim stateCode As Nullable(Of Integer)
Dim stateDescription As String
Dim color As Nullable(Of Integer)
Dim lastEditBy As String
Dim lastEditAt As Nullable(Of Date)
Dim value As DataSet
 
value = JobState.GetAll(stateCode, stateDescription, color, lastEditBy, lastEditAt)

public static DataSet GetAll( 
   Nullable<int> stateCode,
   string stateDescription,
   Nullable<int> color,
   string lastEditBy,
   Nullable<DateTime> lastEditAt
)

Parameters

stateCode: Optional filter parameter. Holds the code of the job or step state.
stateDescription: Optional filter parameter. Holds the description of the job or step state.
color: Optional filter parameter. Holds the RGB color code value of the job or step state.
lastEditBy: Optional filter parameter. Holds the user who added or last changed a job or step state record.
lastEditAt: Optional filter parameter. Holds a date/time when a job or step state record was added or last updated.

Return Value

Returns a DataSet that contains records for all the job and step states that satisfy the specified filters. The returned records include columns from the Job_State table. If no matching job or step states are found, an empty DataSet is returned.

The columns of the returned DataSet are described below.

ColumnName	Description
state_cd	An integer that is the state code.
state_desc	A string that is the state description.
color	An integer that indicates the RGB background color for this state when displayed in the user interface.
last_edit_comment	A string that is 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 that indicates when the record was added or last updated.

MES Stateless API