The response body is of type object.

Returns a JSON array that contains the item consumption records that match the filter parameters. If no matching records are found, null is returned.

The following properties are returned.

row_id (integer)

The record’s unique row ID.

wo_id (string)

The work order ID for identifying the job that consumed the item.

oper_id (string)

The operation ID for identifying the job that consumed the item.

seq_no (integer)

The sequence number of the job that consumed the item.

shift_start_utc (datetime)

The start date and time of the shift during which the consumption occurred in UTC.

shift_start_local (datetime)

The start date and time of the shift during which the consumption occurred in the local time of the entity at which the consumption occurred.

shift_start (datetime)

The start date and time of the shift during which the consumption occurred 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.

item_id (string)

The ID of the consumed item.

item_desc (string)

The item description.

serial_no_lvl (integer)

The number that indicates the level being used, lot or sublot, to indicate individual serial numbers.

0: The lot_no is the serial number.

> 0: A particular sublot level is the serial number.

-1: There are no serial numbers.

lot_no (string)

The lot number of the consumed item.

fg_lot_no (string)

The anticipated finished good lot number of the produced item for genealogy tracking.

sublot_no (string)

The sublot number of consumed item.

fg_sublot_no (string)

The anticipated finished good sublot number of the produced item for genealogy tracking.

reas_cd (integer)

The reason that uniquely identifies the grade + status of goods consumed.

reas_desc (string)

The reason description.

user_id (string)

The ID of the user who ran the job that consumed the item.

user_desc (string)

The user description.

item_scrapped (Boolean)

The indication whether the consumed item is waste.

ent_id (integer)

The ID of the entity at which the item was consumed.

ent_name (string)

The name of the entity at which the item was consumed.

shift_id (integer)

The ID of the shift during which the item was consumed.

shift_desc (string)

The description of the shift during which the item was consumed.

grade_cd (integer)

The grade code of the consumed goods.

item_grade_desc (string)

The grade description.

item_grade_color (string)

The name or hex value of the HTML color that is the background color of the grade in the user interface.

status_cd (integer)

The status code of the consumed goods.

item_status_desc (string)

The status description.

item_state_color (string)

The name or hex value of the HTML color that is the background color of the item state in the user interface.

from_ent_id (integer)

The ID of the storage entity from which the item was consumed.

from_ent_name (string)

The name of the storage entity from which the item was consumed, from the Ent table

qty_cons (double)

The quantity consumed.

qty_cons_erp (double)

The quantity consumed value that was reported to an ERP system.

ext_ref (string)

The reference to an external system for defect tracking or any other purpose.

transaction_type (integer)

The transaction type enumerated value.

0 = normal

1 = lot split

2 = combination

genealogy_id (string)

The genealogy ID.

upstream_event_id (string)

The upstream event ID.

segment_requirement_id (string)

The segment requirement ID.

segment_response_id (string)

The segment response ID.

comments (string)

The comments about the item consumption.

spare1 (string)

The contents of the spare1 field.

spare2 (string)

The contents of the spare2 field.

spare3 (string)

The contents of the spare3 field.

spare4 (string)

The contents of the spare4 field.

last_edit_comment (string)

The comments about why the record was added or updated.

last_edit_by (string)

The ID of the user who added or last updated this record.

last_edit_at (datetime)

The date and time when the record was added or last updated.

created_at_utc (datetime)

The date and time when the item consumption record was created in UTC.

created_at_local (datetime)

The date and time when the item consumption record was created in the local time of the entity at which the consumption occurred.

created_at (datetime)

The date and time when the item consumption record was created 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.

To get the consumption for the job for work order WO20171213.2445, operation Roast, and sequence number 2:

api/consumption?woId=WO20171213.2445&opId=Roast&seqNo=2

To get the consumption for the same job entered by the user tad.smith:

api/consumption?woId=WO20171213.2445&opId=Roast&seqNo=2&userId=tad.smith

To get the consumption for the same job during the morning shift, which has an ID of 2:

api/consumption?woId=WO20171213.2445&opId=Roast&seqNo=2&shiftId=2

Examples: Work Tasks Lookups

To get the consumption for a job:

api/consumption?woId={woId}&opId={opId}&seqNo={seqNo}

To get the consumption for a job for a specific item:

api/consumption?woId={woId}&opId={opId}&seqNo={seqNo}&itemId={itemId}

To get the consumption for a job during a shift:

api/consumption?woId={woId}&opId={opId}&seqNo={seqNo}&shiftId={shiftStart}

All Operations Resource Group | MES Web API V1 Web Service