PauseJobAsync(Int32,String,String,String,Nullable<DateTime>,String,String,Int32,Int32,String,Nullable<Boolean>,Nullable<Int32>) Method

• Visual Basic
• C#

'Declaration
 
Public Overloads Shared Sub PauseJobAsync( _
   ByVal sessionId As Integer, _
   ByVal userId As String, _
   ByVal entName As String, _
   ByVal siteName As String, _
   ByVal jobPauseTimeUtc As Nullable(Of Date), _
   ByVal woId As String, _
   ByVal operId As String, _
   ByVal seqNo As Integer, _
   ByVal pausedJobState As Integer, _
   ByVal statusNotes As String, _
   ByVal checkPrivileges As Nullable(Of Boolean), _
   ByVal jobPos As Nullable(Of Integer) _
) 

'Usage
 
Dim sessionId As Integer
Dim userId As String
Dim entName As String
Dim siteName As String
Dim jobPauseTimeUtc As Nullable(Of Date)
Dim woId As String
Dim operId As String
Dim seqNo As Integer
Dim pausedJobState As Integer
Dim statusNotes As String
Dim checkPrivileges As Nullable(Of Boolean)
Dim jobPos As Nullable(Of Integer)
 
JobExec.PauseJobAsync(sessionId, userId, entName, siteName, jobPauseTimeUtc, woId, operId, seqNo, pausedJobState, statusNotes, checkPrivileges, jobPos)

public static void PauseJobAsync( 
   int sessionId,
   string userId,
   string entName,
   string siteName,
   Nullable<DateTime> jobPauseTimeUtc,
   string woId,
   string operId,
   int seqNo,
   int pausedJobState,
   string statusNotes,
   Nullable<bool> checkPrivileges,
   Nullable<int> jobPos
)

Parameters

sessionId

Required. Holds the ID of the session from which the job is being paused.

userId

Required. Holds the ID of the user who is pausing the job.

entName

Required. Holds the name of the entity on which the job is running.

siteName

Optional. Holds the site name of the entity on which the job is running.

jobPauseTimeUtc

Optional. Holds the pause time, in UTC, of the job. If not provided, the current time in UTC is used.

woId

Required. Holds the work order ID of the job.

operId

Required. Holds the operation ID of the job.

seqNo

Required. Holds the job sequence number.

pausedJobState

Required. Holds the new state of the job. Valid values are 1 (New), 2 (Ready), 4 (Complete), 5 (Suspended), 6 (On hold).

statusNotes

Optional. Holds notes associated with the state change. Default is null.

checkPrivileges

Optional. Holds a flag that, if set to true, specifies that the user’s privileges should be checked before executing this action. Default is false.

jobPos

Optional. Holds the job position. If greater than 1, jobs are running on this entity.