V3_Jobs_End (Put)
- Last UpdatedNov 06, 2025
- 1 minute read
| Put | V3_Jobs_End |
Resource Path:/api/v3/Jobs/End
| 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.
Required. The property information to set the job's state to Complete.
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 is not required, as it will be set to 4 (Completed) by the system.
Additional Information
For the endpoint to succeed, the specified job must be in the Running, Suspended, or On Hold state on the specified entity.
If the call is successful, the Job table is updated as follows for the specified job:
- state_cd = 4 (Completed)
- 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.