V3_Jobs_Pause (Put)
- Last UpdatedNov 06, 2025
- 2 minute read
| Put | V3_Jobs_Pause |
Resource Path:/api/v3/Jobs/Pause
| Name | Description |
|---|---|
| trans_id | Used to supply the ID of the transaction if the call is taking part in a transaction. |
The request body is of type Mes.WebApi.Models.V3.Prod.Job.
The response body is of type Mes.WebApi.Models.V3.Prod.Job.
OKThe following Job model properties are required.
- To identify the entity: run_ent_id.
- To identify the job: wo_id, oper_id, and seq_no. If this job information is not supplied, then the system will check the job_pos property to identify the job. If the job_pos property is not supplied, then the system will check job position 0 to identify the job.
The state_cd can be set to 5 (Suspended) or 6 (On Hold). If it is set to 3 (Running), it defaults to 5 (Suspended).
Additional Information When Pausing a Job
For the call to succeed at pausing the job, the job must in the Running state on the specified entity.
If the call is successful, the Job table is updated as follows for the specified job:
- state_cd = state_cd
- status_notes = status_notes
- act_finish_time_utc = act_finish_time_utc or, if null, current UTC time
The current job data fields in the Job_Exec table are updated as follows for this entity:
- cur_wo_id = null
- cur_oper_id = null
- cur_seq_no = 0
- cur_step_no = null
- cur_step_start = null
If no value for act_finish_time_utc is supplied, the job_end* times in the Job_History table are updated with the current UTC time.
Job State Codes
The enumeration values that indicate the job states are:
1 = New
2 = Ready
3 = Running (in progress)
4 = Complete
5 = Suspended
6 = On Hold
7 = Canceled
Using This Endpoint to Change the Job State to New or Ready
This endpoint can also be used to change the job state to New or Ready. You might want to do this, say, if the job was started (Running) by mistake.