Versions
Versions this documentation is relevant for:
- 8.7.0+
A BoM slot is a requirement to be satisfied in a BoM. It is linked to a specific BoM Version.
List
The BoM Slot – List API call reads existing BoM Slots from Eyelit MES-M. The data can be filtered based on the parameters passed in the body/payload of the JSON packet giving the flexibility to search for one or multiple BoM Slots.
Using the BoM Slot – List API call has no impact on the data within the given Eyelit MES-M application, it is read-only.
Figure 1 - Logic within Bom Slot/List API Call
Data Prerequisites
There is no data required in Eyelit MES-M to act as a pre-requisite to make the API call to list BoM Slots. If parameters are passed in through the body that return no valid results, an empty payload will be returned.
Request
Table 1 shows the method and endpoint required to make the API call to list Scheduled Jobs.
Table 1 - Outbound Message Detail for BoM Slot - List
Method | URL Structure | Endpoint |
POST | https://[environment].mestec.net | /api/BomSlot/List |
The body of the payload should follow the format below.
JSON Structure for BoM Slot List
See Table 2 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 2 - Parameter Information for Schedule - List
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
Id | Bomslot.id | NUMBER(10,0) | No | N/A | Exact |
Product | Product.name | VARCHAR2(50 BYTE) | No | No | Exact |
Bom | Bom.name | VARCHAR2(100 BYTE) | No | No | Exact |
Version | Bomversion.majorversion/minorversion | N/A | No | No | Exact |
slotType | Buildslottype.buildslottypename | VARCHAR2(50 BYTE) | No | No | Exact |
isActive | Bomslot.isactive | BOOL | No | N/A | Exact |
isRequired | Bomslot.isrequired | BOOL | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
To list BoM Slots where the from BoM ‘BomABC’:
JSON Sample for BoM Slot List Request B
Response
When using the BoM Slot – List API call, if any data has been found in Eyelit MES-M that meets the parameter values passed in the original payload, a JSON payload will be returned containing data in the following structure:
JSON Structure for BoM Slot List
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
No results were found that matched given parameters:
JSON Sample for BoM Slot List Response A
BoM Slots found that matched given parameters:
JSON Sample for BoM Slot List Response B
Upsert
When BoM Slot ID is provided, The BoM Slot – Upsert API call checks if a BoM Slot with the given ID already exists. If it does, appropriate fields are updated in the matching BoM Slot in Eyelit MES-M. 
When the BoM Slot ID is omitted, a new BoM Slot will be created.
Figure 2 - Logic within BoM Slot/Upsert API Call
Data Prerequisites
A BoM Slot references a BoM Version, these must all exist in Eyelit MES-M prior to BoM Slot upsert.
Request
Table 3 shows the method and endpoint required to make the API call to Upsert BoM Slot.
Table 3 - Outbound Message Detail for BoM Slot - Upsert
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/BomSlot/Upsert |
The body of the payload should follow the format below.
See Table 4 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 4 - Parameter Information for BoM Slot - Upsert
Parameter Name | Data Mapping | Data Type | Mandatory |
| Case Sensitive | Match Type |
|
|
| Create | Update |
|
|
ParentProductName | Product.name | VARCHAR2(50 BYTE) | Yes | No |
|
|
id | Bmoslot.id | NUMBER(10,0) | N/A | Yes | N/A | Exact |
bom | Bom.name | VARCHAR2(100 BYTE) | Yes | No | No | Exact |
version | Bom.majorversion/minorversion | N/A | Yes | No | N/A | N/A |
description | Bomslot.description | VARCHAR2(200 BYTE) | Yes | No | N/A | N/A |
buildSlotType | Buildslottype.name | VARCHAR2(50 BYTE) | Yes | No | No | Exact |
isActive | Bomslot.isactive | BOOL | Yes | No | N/A | N/A |
isRequired | Bomslot.isrequired | BOOL | Yes | No | N/A | N/A |
instruction | Bomslot.instruction | VARCHAR2(2000 BYTE) | No | No | N/A | N/A |
edhrBomRequired | Bomslot. edhrbomrequired | Number | Yes | No |
|
|
edhrBuildRequired | Bomslot.edhrbuildrequired | Number | Yes | No |
|
|
candidates | N/A | JSON Array | No | No | N/A | N/A |
id | Bomslotcandidate.id | NUMBER(10,0) | No | Yes | N/A | Exact |
product | Product.name | VARCHAR2(50 BYTE) | Yes | No | No | Exact |
version | Bomsltcandidate.version | VARCHAR2(50 BYTE) | No | No | N/A | N/A |
isActive | Bomslotcandidate.isactive | BOOL | Yes | No | N/A | N/A |
qty | Bomslotcandidate.childqty | FLOAT | Yes | No | N/A | N/A |
minQty | Bomslotcandidate.minqty | FLOAT | Yes | No | N/A | N/A |
maxQty | Bomslotcandidate.maxqty | FLOAT | No | No | N/A | N/A |
isDefault | Bomslotcandidate.isdefaultcandidate | BOOL | Yes | No | N/A | N/A |
useUom | Unitofmeausre.unitname | VARCHAR2(30 BYTE) | No | No | No | Exact |
Properties | N/A | JSON Array | No | No | N/A | N/A |
property | Tablepropertydefinition.propertyname | VARCHAR2(50 BYTE) | Yes | No | No | Exact |
slotID | Bomslotproperty.tableid | NUMBER(10,0) | No | No | N/A | Exact |
value | Bomslotproperty.value | VARCHAR2(500 BYTE) | Yes | No | N/A | N/A |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
To create a BoM Slot.
To update description by ID.
Response
When using the BoM Slot – Upsert API call, if a BoM Slot has been Created or Updated a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
Delete
The BoM Slot – Delete API call attempts to delete a BoM Slot. A BoM Slot can be deleted as long as it has not been used.
Figure 3 shows the logic used within the BoM Slot – Delete API call.
Figure 3 - Logic within BoM Slot/Delete API Call
Data Prerequisites
In order to delete a BoM Slot it must exist in Eyelit MES-M and not currently be in use.
Request
Table 5 shows the method and endpoint required to make the API call to delete a BoM Slot.
Table 5 - Outbound Message Detail for BoM Slot - Delete
Method | URL Structure | Endpoint |
DELETE | https://[environment].mestec.net | /api/BomSlot/Delete |
The body of the payload should follow the format below.
See Table 6 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 6 - Parameter Information for BoM Slot - Delete
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
ID | Bom Slot.id | NUMBER | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Delete by ID
Response
When using the BoM Slot – Delete API call, if a BoM Slot has been Deleted a 200 status response will be returned.
List Candidates
The BoM Slot Candidate – List API call reads existing BoM Slot Candidates from Eyelit MES-M. The data can be filtered based on the parameters passed in the body/payload of the JSON packet giving the flexibility to search for one or multiple BoM Slot Candidates.
Using the BoM Slot Candidate – List API call has no impact on the data within the given Eyelit MES-M application, it is read-only.
Figure 4 - Logic within BoM Slot Candidate/List API Call
Data Prerequisites
There is no data required in Eyelit MES-M to act as a pre-requisite to make the API call to list BoM Slot Candidates. If parameters are passed in through the body that return no valid results, an empty payload will be returned.
Request
Table 7 shows the method and endpoint required to make the API call to list Scheduled Jobs.
Table 7 - Outbound Message Detail for BoM Slot Candidate - List
Method | URL Structure | Endpoint |
POST | https://[environment].mestec.net | /api/BomSlot/ListCandidates |
The body of the payload should follow the format below.
JSON Structure for BoM Slot Candidate List
See Table 8 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 8 - Parameter Information for BoM slot candidates - List
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
bomSlotID | Bomslot.id | NUMBER(10,0) | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
To list BoM Slot Candidates by BoM Slot ID:
JSON Sample for BoM Slot Candidate List Request B
Response
When using the BoM Slot Candidate – List API call, if any data has been found in Eyelit MES-M that meets the parameter values passed in the original payload, a JSON payload will be returned containing data in the following structure:
JSON Structure for BoM Slot Candidate List
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
No results were found that matched given parameters:
JSON Sample for BoM Slot Candidate List Response A
BoM Slot Candidates found that matched given parameters:
JSON Sample for BoM Slot Candidate List Response B
Upsert Candidates
When BoM Slot Candidate ID is provided, The BoM Slot– UpsertCandidates API call checks if a BoM Slot Candidate with the given ID already exists. If it does, appropriate fields are updated in the matching BoM Slot Candidate in Eyelit MES-M. 
When the BoM Slot Candidate ID is omitted, a new BoM Slot Candidate will be created.
Figure 5 - Logic within BoM Slot/UpsertCandidates API Call
Data Prerequisites
A BoM Slot Candidate references a product, and a BoM slot, these must all exist in Eyelit MES-M prior to BoM Slot- UpsertCandidates.
Request
Table 9 shows the method and endpoint required to make the API call to Upsert BoM Slot Candidate.
Table 9 - Outbound Message Detail for BoM Slot-UpsertCandidates
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/BomSlot/UpsertCandidates |
The body of the payload should follow the format below.
See Table 10 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 10 - Parameter Information for BoM Slot-UpsertCandidates
Parameter Name | Data Mapping | Data Type | Mandatory |
| Case Sensitive | Match Type |
|
|
| Create | Update |
|
|
bomSlotID | Bomslot.id | NUMBER(10,0) | Yes | Yes | N/A | Exact |
candidates | N/A | JSON Array | Yes | Yes | N/A | N/A |
id | Bomslotcandidate.id | NUMBER(10,0) | N/A | Yes | N/A | Exact |
product | Product.name | VARCHAR2(50 BYTE) | Yes | No | No | Exact |
version | Bomsltcandidate.version | VARCHAR2(50 BYTE) | No | No | N/A | N/A |
isActive | Bomslotcandidate.isactive | BOOL | Yes | No | N/A | N/A |
qty | Bomslotcandidate.childqty | FLOAT | Yes | No | N/A | N/A |
minQty | Bomslotcandidate.minqty | FLOAT | Yes | No | N/A | N/A |
maxQty | Bomslotcandidate.maxqty | FLOAT | No | No | N/A | N/A |
isDefault | Bomslotcandidate.isdefaultcandidate | BOOL | Yes | No | N/A | N/A |
useUom | Unitofmeausre.unitname | VARCHAR2(30 BYTE) | No | No | No | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
To created a BoM Slot Candidate.
To update is Active by ID.
Response
When using the BoM Slot - UpsertCandidates API call, if a BoM Slot Candidate has been Created or Updated a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
Delete Candidate
The BoM Slot Candidate – Delete API call attempts to delete a BoM Slot Candidate. A BoM Slot Candidate can be deleted as long as it has not been used.
Figure 6 shows the logic used within the BoM Slot Candidate – Delete API call.
Figure 6 - Logic within BoM Slot/DeleteCandidate API Call
Data Prerequisites
In order to delete a BoM Slot Candidate it must exist in Eyelit MES-M and not currently be in use.
Request
Table 11 shows the method and endpoint required to make the API call to delete a BoM Slot Candidate.
Table 11 - Outbound Message Detail for BoM Slot- DeleteCandidiate
Method | URL Structure | Endpoint |
DELETE | https://[environment].mestec.net | /api/BomSlot/DeleteCandidate |
The body of the payload should follow the format below.
See Table 12 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 12 - Parameter Information for BoM Slot- DeleteCandidate
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
ID | Bom Slot Candidate.id | NUMBER | Yes | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Delete by ID
Response
When using the BoM Slot Candidate – Delete API call, if a BoM Slot candidate has been Deleted a 200 status response will be returned.
List Properties
The BoM Slot– List Properties API call reads existing BoM Slot Properties from Eyelit MES-M. The data can be filtered based on the parameters passed in the body/payload of the JSON packet giving the flexibility to search for one or multiple BoM Slot Properties.
Using the BoM Slot Properties – List API call has no impact on the data within the given Eyelit MES-M application, it is read-only.
Figure 7 - Logic within BoM Slot/ListProperties API Call
Data Prerequisites
There is no data required in Eyelit MES-M to act as a pre-requisite to make the API call to list BoM Slot Properties. If parameters are passed in through the body that return no valid results, an empty payload will be returned.
Request
Table 13 shows the method and endpoint required to make the API call to list Scheduled Jobs.
Table 13 - Outbound Message Detail for BoM Slot- ListProperties
Method | URL Structure | Endpoint |
POST | https://[environment].mestec.net | /api/BomSlot/ListProperties |
The body of the payload should follow the format below.
Figure 41 - JSON Structure for BoM Slot Properties List
See Table 14 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 14 - Parameter Information for BoM Slot- ListProperties
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
bomSlotID | Bomslot.id | NUMBER(10,0) | No | N/A | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string. See examples in Section 3.1.3.1 for use cases.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
To list BoM Slot Properties by BoM slot ID:
JSON Sample for BoM Slot Properties List Request B
Response
When using the BoM Slot Properties – List API call, if any data has been found in Eyelit MES-M that meets the parameter values passed in the original payload, a JSON payload will be returned containing data in the following structure:
JSON Structure for BoM Slot Properties List
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
No results were found that matched given parameters:
JSON Sample for BoM Slot Properties List Response A
BoM Slot Properties found that matched given parameters:
JSON Sample for BoM Slot Properties List Response B
Upsert Properties
This endpoint allows for the setting of BoM Slot Property values. The properties cannot be created from this transaction.
Figure 8 - Logic within BoM Slot/UpsertProperties API Call
Data Prerequisites
The BoM Slot and the property definition must already exist in Eyelit MES-M.
Request
Table 15 shows the method and endpoint required to make the API call to Upsert BoM Slot Properties.
Table 15 - Outbound Message Detail for BoM Slot- UpsertProperties
Method | URL Structure | Endpoint |
PUT | https://[environment].mestec.net | /api/BomSlot/UpsertProperties |
The body of the payload should follow the format below.
See Table 16 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 16 - Parameter Information for BoM Slot-UpsertProperties
Parameter Name | Data Mapping | Data Type | Mandatory |
| Case Sensitive | Match Type |
|
|
| Create | Update |
|
|
bomSlotID | Bomslot.id | NUMBER(10,0) | Yes | Yes | N/A | Exact |
properties | N/A | JSON Array | Yes | Yes | N/A | N/A |
property | Tablepropertydefinition.propertyname | VARCHAR2(50 BYTE) | Yes | No | No | Exact |
value | Bomslotproperty.value | VARCHAR2(500 BYTE) | Yes | No | N/A | N/A |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
To set a BoM Slot Properties.
Response
When using the BoM Slot– Upsert Properties API call, if a BoM Slot Properties has been Created or Updated a JSON payload will be returned containing data in the following structure:
Sample Response
See below for sample use cases with examples of the JSON payload format returned.
Clear Property
The BoM Slot Property – Clear API call attempts to clear a BoM Slot Property. A BoM Slot Property can be cleared as long as it has not been used.
Figure 9 shows the logic used within the BoM Slot Property – Clear API call.
Figure 9 - Logic within BoM Slot/ClearProperty API Call
Data Prerequisites
In order to clear a BoM Slot Property it must exist in Eyelit MES-M and not currently be in use.
Request
Table 17 shows the method and endpoint required to make the API call to clear a BoM Slot Property.
Table 17 - Outbound Message Detail for BoM Slot - ClearProperty
Method | URL Structure | Endpoint |
DELETE | https://[environment].mestec.net | /api/Bom Slot/ClearProperty |
The body of the payload should follow the format below.
See Table 18 for information on which fields are optional, the appropriate data types and the mappings to fields in Eyelit MES-M.
Table 18 - Parameter Information for BoM Slot - ClearProperty
Parameter Name | Data Mapping | Data Type | Mandatory | Case Sensitive | Match Type |
BomSlotId | Bom Slot.id | NUMBER | Yes | N/A | Exact |
property | Tablepropertydefiniiton.name | VARCHAR2(50 BYTE) | Yes | No | Exact |
Note: For any fields where the match type is ‘Like’, a percent symbol should be used as a wildcard character to indicate a number of characters within the given string. See examples in Section 3.1.3.1 for use cases.
Sample Request
See below for sample use cases with examples of the JSON payload format required.
Clear by ID and Property Name
Response
When using the BoM Slot– Clear Property API call, if property has been cleared a 200 status response will be returned.
