V3_Jobs_Start (Put)
- Last UpdatedNov 06, 2025
- 2 minute read
| Put | V3_Jobs_Start |
Resource Path:/api/v3/Jobs/Start
| 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: ent_id.
- To identify the job: wo_id, oper_id, and seq_no.
- To identify the entity on which the job is actually run: run_ent_id.
The state_cd is not required, as it will be set to 3 (Running) by the system.
Additional Information
For the call to succeed, the following must be true:
- The job can be started on the supplied entity (i.e., the retrieved job_pos is not -1).
- The job is not in the Running, Completed, or Canceled state.
- The system is able to get a job position for each job in the batch.
This method starts a job or a batch of jobs. It retrieves the status of the current job and its concurrent link number for the supplied work order ID, operation ID, and sequence number.
If the concurrent link is 0, that indicates that the current job to start is not linked to a batch. The current job will be started on the supplied job_pos. If the supplied job_pos is null, then the system retrieves the job_pos for the supplied entity ID and starts the job.
If the current job is linked to a batch, then all the linked jobs in a batch are started. To start all the linked jobs, the available job positions for the supplied entity are retrieved. If the job position is available, then the job is started at the available job position. For the rest of the linked jobs, the system iterates through each job in the batch and checks that the job is not in a Running, Completed or Canceled state. The system then retrieves the available job position and starts the job on that position.
A new record will be created in the Job_History table with the supplied job information. The job_start* times will use the current time if no value for the act_start_time_utc parameter is supplied. Otherwise, the supplied start time will be used.