JobQueue_Get (Get)
- Last UpdatedNov 06, 2025
- 7 minute read
| Get | JobQueue_Get |
Resource Path:/api/entity/{entityID}/JobQueue
| Name | Description | Data Type |
|---|---|---|
| entityID | The entity ID. Required for the api/entity/{entityId}/JobQueue endpoint, which gets the jobs for the specified entity. | integer |
| woId | The work order ID. | string |
| itemId | The item ID. | string |
| newState | An indication whether to include jobs in the New state. | boolean |
| readyState | An indication whether to include jobs in the Ready state. | boolean |
| runningState | An indication whether to include jobs in the Running state. | boolean |
| completeState | An indication whether to include jobs in the Complete state. | boolean |
| suspendedState | An indication whether to include jobs in the Suspended state. | boolean |
| onholdState | An indication whether to include jobs in the OnHold state. | boolean |
| cancelledState | An indication whether to include jobs in the Canceled state. | boolean |
| lastNhrs | The number of previous hours of data to include. | integer |
| maxRows | The maximum number of jobs to return. The top n jobs are returned based on their scheduled start time and then their priority. | integer |
| inclSchedParents | An indication whether to include jobs scheduled to ancestors of the entity, if an entity is specified by the entityID parameter. | boolean |
The response body is of type object.
Returns a JSON array that contains the information about the jobs. If no matching jobs are found, an empty JSON array is returned.
The following properties are returned.
item_id (string)
The ID of the item produced by the job.
item_desc (string)
The description of the item produced by the job.
uom_id_h (integer)
The ID of the unit of measure (UOM) for the item.
uom_description (string)
The description of the UOM for the item.
lifetime (integer)
The lifetime of this item before it expires, in days. If null, the item never expires.
unit_cost (double)
The cost for one unit of the item.
item_class_id (integer)
The ID of the item class to which the produced item belongs.
item_class_desc (string)
The description of the item class to which the produced item belongs.
process_id (string)
The ID of the process from which the job was created.
process_status (integer)
The status of the process from which the job was created.
wo_id (string)
The work order ID for the job.
req_qty (double)
The required quantity of the final item produced by the work order.
release_time_utc (datetime)
The release time of the work order in UTC.
release_time_local (datetime)
The release time of the work order in the local time of the entity to which the job is assigned.
release_time (datetime)
The release time of the work order in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
wo_priority (integer)
The work order priority.
cust_info (string)
The work order customer information.
oper_id (string)
The operation ID for the job.
seq_no (integer)
The sequence number for the job.
job_desc (string)
The job description.
state_cd (integer)
The current state of the job.
job_priority (integer)
The priority of the job.
req_finish_time_utc (datetime)
The time by when to finish the operation in UTC.
req_finish_time_local (datetime)
The time by when to finish the operation in the local time of the entity on which the job is scheduled.
req_finish_time (datetime)
The time by when to finish the job in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
target_sched_ent_id (integer)
The ID of the target schedule entity.
ent_name (string)
The name of the entity on which the job is scheduled.
qty_reqd (double)
The quantity that the job must produce.
qty_prod (double)
The quantity already produced.
qty_rejected (double)
The quantity already rejected.
qty_at_start (double)
The quantity that the job will produce if nothing is scrapped.
batch_size (double)
The batch size.
first_job (Boolean)
The indication whether this is a first job in the work order.
final_job (Boolean)
The indication whether this is a final job in the work order.
est_prod_rate (double)
The estimated entity batch rate or time, depending on the produced item UOM.
sched_start_time_utc (datetime)
The scheduled start time for the job in UTC.
sched_start_time_local (datetime)
The scheduled start time for the job in the local time of the entity on which the job is scheduled.
sched_start_time (datetime)
The scheduled start time for the job in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
latest_start_time_utc (datetime)
The latest time the job may start in UTC.
latest_start_time_local (datetime)
The latest time the job may start in the local time of the entity on which the job is scheduled.
latest_start_time (datetime)
The latest time the job may start in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
sched_finish_time_utc (datetime)
The scheduled finish time for the job in UTC.
sched_finish_time_local (datetime)
The scheduled finish time for the job in the local time of the entity on which the job is scheduled.
sched_finish_time (datetime)
The scheduled finish time for the job in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
notes (string)
The notes about the job.
status_notes (string)
The notes about the job status.
state_desc_h (string)
The description of the current state of the job.
color_h (string)
The name or hex value of the HTML color that is the color in which the job is displayed in the user interface to indicate the state.
oper_desc (string)
The description of the operation for the job.
act_start_time_utc (datetime)
The actual starting time of the job in UTC.
act_start_time_local (datetime)
The actual starting time of the job in the local time of the entity on which the job is scheduled.
act_start_time (datetime)
The actual starting time of the job in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
act_finish_time_utc (datetime)
The actual finish time of the job in UTC.
act_finish_time_local (datetime)
The actual finish time of the job in the local time of the entity on which the job is scheduled.
act_finish_time (datetime)
The the actual finish time of the job in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.
can_sched_jobs (Boolean)
The indication whether the targeted entity can schedule jobs.
mo_id (string)
The manufacturing order ID associated with the work order.
run_ent_id (integer)
The ID of the entity on which the job is run.
Run_Ent_name (string)
The name of the entity on which the job is run.
row_id_h (integer)
The row ID of the job record in the Job table.
num_decimals_h (integer)
The number of decimals to be used in displaying quantities for the item produced by the job.
num_decimals_good_pp (integer)
The value of the system attribute Max decimals of good piece part entries (attr_id 326 in the System_Attr table) to determine the maximum number of decimals to use when num_decimals is 0.
spare1 (string)
The contents of the item spare1 field.
spare2 (string)
The contents of the item spare2 field.
spare3 (string)
The contents of the item spare3 field.
spare4 (string)
The contents of the item spare4 field.
edit_time_h (datetime)
The last time the job record was edited, in UTC.
job_pos_h (integer)
The job position used to run the job. If the job is not running, the value is null.
def_lot_no (string)
The default lot number for items produced by the job.
job_spare1 (string)
The contents of the job_spare1 field.
job_spare2 (string)
The contents of the job_spare2 field.
job_spare3 (string)
The contents of the job_spare3 field.
job_spare4 (string)
The contents of the job_spare4 field.
concurrent_link (integer)
The number used to link the job to others so that all jobs start at the same time. A value of 0 indicates that the job is a single job and is not linked to other jobs.
wo_desc (string)
The description of the work order.
queue_item_item_id_h (string)
The item whose attributes are to be included in the returned array for display in the queue.
The item attributes that are returned are those whose visible_in_queue is set to true.
The attribute information is returned as the following column pair:
- attr<attr_id>, which is the attribute value whose ID is the <attr_id> part of the column name
- attr<attr_id>d_h, which is the attribute description whose ID is the <attr_id> part of the column name
queue_job_wo_id_h (string)
The ID of the work order that, along with queue_job_oper_id_h and queue_job_seq_no_h, identify the job whose attributes are to be included in the returned array for display in the queue.
The job attributes that are returned are those whose visible_in_queue is set to true.
The attribute information is returned as the following column pair:
- attr<attr_id>, which is the value of the attribute whose ID is the <attr_id> part of the column name
- attr<attr_id>d_h, which is the description of the attribute whose ID is the <attr_id> part of the column name
queue_job_oper_id_h (string)
The ID of the operation that is used to identify the job whose attributes are to be included in the returned array for display in the queue.
queue_job_seq_no_h (integer)
The sequence number that is used to identify the job whose attributes are to be included in the returned array for display in the queue.