MES Web API V1 Web Service

Add item consumption for a job.

You can add consumption by identifying the job as described below. For all three approaches, the Consumption model properties are required in the request body.

Add item consumption for the currently running job on an entity, specifying the entity ID:

In the call, provide the entId parameter and optionally the fromEntId parameter, which are described in the Parameters table.

Add item consumption for the currently running job on an entity, specifying the entity name.

In the call, provide the entName parameter and optionally the other parameters described below:

entName (string)

Required. The entity name.

siteName (string)

The name of the site to which the entity belongs.

fromEntName (string)

The name of the storage entity from which consumption is occurring.

fromSiteName (string)

The name of the site to which the storage entity belongs.

Add item consumption for a specific job.

In the call, provide the parameters as described below:

wo_id (string)

Required. The job's work order ID.

oper_id (string)

Required. The job's operation ID.

seq_no (integer)

Required. The job's sequence number.

entName (string)

Required. The entity name.

siteName (string)

The name of the site to which the entity belongs.

fromEntName (string)

The name of the storage entity from which consumption is occurring.

fromSiteName (string)

The name of the site to which the storage entity belongs.

Get counts and duration for an entity or a line.

Get item-process links for all processes or a specific process.

To get the links for all processes: Do not include any parameters in the call. This call returns an array of objects with the properties in the ItemProcessLink model.

To get the links for a specific process: Include the processId (string) parameter in the call (e.g., /api/ItemProcessLink/{processId}). This call returns an array of objects with the following properties:

item_id (string)

The item ID.

process_id (string)

The process ID.

item_pref (integer)

The preferred process value. The process with the lowest value in this field is the preferred one.

status (integer)

The status of this process/item combination:

-1 = Disabled

1 = Experimental

2 = Approved (the default)

3 = Certified

last_edit_comment (string)

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, in UTC, when the record was added or last updated.

mod_id (timestamp)

A binary number that increments each time the row is modified.

Get all item reasons or get item reasons for a specific entity.

To get all item reasons: Do not include any parameters in the call.

To get item reasons for a specific entity: Include the following parameters in the call; the optional parameters allow you to filter the entity's item reasons:

entId (integer)

Required. The entity ID.

itemId (string)

The item ID.

reasGrpType (integer)

An enumeration that indicates the reason group type.

0 = Hidden

1 = Production

2 = Consumption

3 = Waste

You can use this endpoint in the following ways:

• To change a ready (New or Ready) or paused (Suspended, On Hold) job to running, or change a running job to Complete to end it.
• To change the job state to a desired, valid state.

Both approaches use the woId, operId, and seqNo parameters in the Parameters table to identify the job.

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

To Start a Ready or Paused Job, or End a Running Job

• Use the woId, operId, and seqNo parameters to identify the job. If this job information is not supplied, then the system will check the  job_pos property specified in the request body to identity the job. If the job_pos property is not supplied, then the system will check job position 0 to identify the job.
• In the request body, set the Job model state_cd property to the current state of the job. For example, if the job is currently in the Ready state, the state_cd property will be 2.
• In the request body, set the run_ent_id property to specify the entity for the job.

The other Job model property values are ignored.

When the call is processed:

• If the state_cd property passed in the model is 1, 2, 5, or 6 (New, Ready, Suspended, On Hold), the job's state will be changed to 3 (Running).
• If the state_cd property passed in the model is 3 (Running), the job's state will be changed to 4. (Completed).

To Change the Job State

• Use the woId, operId, and seqNo parameters to identify the job.
• Use the stateCd parameter to specify the enumeration code for the new state. The new state must be valid within the context of the current state. For example, the Complete state cannot be changed to the New state.
• Optionally, use the notes parameter to include a notes string about the job state change.
• In the request body, use the run_ent_id property to specify the entity for the job. The other properties in the model are ignored, including the state_cd property.

Get the production or bottleneck entities on a line, optionally within a specified time period.

To get all production or bottleneck entities: Include only the parameters described in the Parameters table.

To filter the production or bottleneck entities by a time period: In addition to the parameters described in the Parameters table, include the following parameters.

filterType (integer)

The ID of the time period filter type to use.

0 = Current hour

1 = Last n hours, where n is the number of hours specified by the filterDuration parameter

2 = Current shift

3 = Previous shift

4 = Current day

5 = Yesterday

6 = Current week

7 = Previous week

8 = Current month

9 = Previous month

filterDuration (string)

If the filter type is set to 1, last n hours, this is the value for n (that is, the number of hours). If no value is provided, the default value of 1 hour is used.

Get data by submitting an XML request that specifies a stored procedure or by specifying a stored procedure directly.

• When submitting an XML request, the XML string is supplied in the request body.
• When specifying a stored procedure directly, you must include the object and cmd parameters in the URL and supply the JSON string in the request body. If the URL does not include the object and cmd parameter, then the method assumes that an XML string is being passed in the request body.

Add data by submitting an XML request that specifies a stored procedure or by specifying a stored procedure directly.

• When submitting an XML request, the XML string is supplied in the request body.
• When specifying a stored procedure directly, you must include the sessionId parameter in the URL and supply the JSON string in the request body. If the URL does not include the sessionId parameter, then the method assumes that an XML string is being passed in the request body.

You can use this endpoint to add an operation or, optionally, add an operation created from a standard operation. Both endpoint uses return the Operation model in the response body.

To add an operation not created from a standard operation: Include the OperationConfiguration model properties in the call's request body with no other parameters.

To add an operation created from a standard operation: Include the processId parameter and include the OperationFromStandardOperation model properties in the call's request body as described below.

standardOperationId (string)

Required. The ID of the standard operation on which the new operation will be based.

opFromStdOp (request body)

Required. The property information for the operation. The body is of type OperationFromStandardOperation.

OperationFromStandardOperation Model Properties

The OperationFromStandardOperation model properties are described below.

ProcessId (string)

Required. The ID of the process to which the new operation belongs.

OperationId (string)

Required. The ID of the new operation.

OperationDescription (string)

The description of the new operation.

DisplaySequence (integer)

Required. The display sequence number for the new operation, which determines the order in which operations are listed in the user interface.

StandardOperationId (string)

This property is ignored because the standard operation is identified by the standardOperationId parameter that is provided in the call's URL.

Get information about all processes or a specific process.

To get information about all processes: Do not include any parameters in the call.    

To get information about a specific process: Include the following parameters in the call:

id (string)

Required. The process ID.

verify (Boolean)

The indication whether or not the process should be verified.

Get a specific utilization history event or get all of an entity's events.

When getting a specific utilization history event, the endpoint retrieves the specified event. It also retrieves the objects for the previous and next events. Having the previous and next events allows the target event and the events prior to and after it to be displayed in a Gantt chart in the UI when splitting the event.

Summary (Web Service Definition)

Update utilization history events.

This endpoint can be used to update a single utilization history event or add multiple utilization history events to split an event. If splitting an event, this method will update the target event and add the new event specified in the request body to the Util_History table. The two events should be split as necessary to maintain a consecutive timeline of events over the time period.

Get information about one or more work orders.

You can filter the work orders by line, time period, and one job-related work order status. You can also filter the work orders by all job-related work order statuses together and other filters.

Filter the work orders by line, time period, and a job-related work order status

Use the following parameters to filter the work orders by line, time period, and a job-related work order status. This Get returns an array of objects that are of type WO model.

Parameters:

woId (string)

The work order ID. If not provided, all work orders that match the other filter parameters will be returned.

targetScheduleLineId (integer)

The ID of a line on which work orders have been scheduled.

lastEditHr (integer)

This filter applies only to Completed or Canceled work orders. The number hours prior to the current time during which work orders have been completed or canceled.

statusCd (integer)

The job-related status code of the work order:

1 = New

2 = Ready

3 = Running (In Progress)

4 = Complete

5 = Suspended

6 = On Hold

The work order status code is based on the status of its member jobs according to the first true condition in the following order:

1. If there is a job running, the work order status is Running.
2. If all the jobs are completed or canceled, the work order status is Complete.
3. If there is any one on-hold job, then the work order status is On Hold.
4. If there is any one suspended job, then the work order status is Suspended.
5. If there is any one ready job, then the work order status is Ready.
6. If none of the above conditions are true, the work status is New.

Filter the work orders by their jobs' statuses and other filters

Use the following parameters to filter the work orders by all job-related work order statuses together and several other filters. Instead of returning an array of objects based on the WO model, this Get returns an array of objects with the properties described below under "Response."

Parameters:

Note: All of the state filter parameters are required, even if their values are set to false. If you do not provide a value for even one of the state filter parameters, then the other version of the workorder endpoint is used and an array of objects that are of type WO model will be returned instead of the JSON array returned by this version of the endpoint. Also, all non-state filter parameter settings will still be implemented in the call of the other workorder endpoint.

newState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the New state.

readyState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the Ready state.

runningState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the Running state.

completeState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the Complete state.

suspendedState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the Suspended state.

onholdState (Boolean)

Required. Indicates whether to include work orders that have any jobs in the On Hold state.

woId (string)

The work order ID of a specific work order. If not provided, all work orders that match the other filter parameters will be returned.

itemId (string)

The ID of an item being produced.

numberOfWos (integer)

The maximum number of work order records to return.

If no value is supplied and there are a large number of work order records, system performance might be affected as all work orders that match the other filter parameters will be returned.

targetScheduleLineId (integer)

The ID of a line on which work orders have been scheduled. If null, only work orders not assigned to a line will be considered in the retrieval. To ignore this parameter so that all work orders that are assigned to lines will be considered in the retrieval, set the value to -1.

lastEditHr (integer)

This filter applies only to Completed or Canceled work orders. Enter the number hours prior to the current time during which work orders have been completed or canceled.

includeFromProcess (Boolean)

Indicates whether to include work orders created from a process. The default is false.

Add a work order, optionally created from a process.

To add a work order not created from a process: Include only the WO model properties in the call's request body.

To add a work order created from a process: In addition to the WO model properties in the call's request body, include the processId parameter.

processId (string)

Required. The ID of the process from which to create the work order.