1. Overview
Microservice containing the business logic for managing product-service.
1.2. Tags
-
bom-family-controller : Bom Family Controller
-
bom-formulation-controller : Bom Formulation Controller
-
bom-master-controller : Bom Master Controller
-
consumption-operations-controller : Consumption Operations Controller
-
engineering-units-controller : Engineering Units Controller
-
material-lot-command-controller : Material Lot Command Controller
-
material-lot-controller : Material Lot Controller
-
material-lot-property-group-controller : Material Lot Property Group Controller
-
material-lot-status-controller : Material Lot Status Controller
-
material-traceability-controller : Material Traceability Controller
-
product-controller : Product Controller
-
product-execution-path-controller : Product Execution Path Controller
-
product-family-controller : Product Family Controller
-
product-group-controller : Product Group Controller
-
product-property-group-controller : Product Property Group Controller
-
product-property-value-controller : Product Property Value Controller
-
product-unit-controller : Product Unit Controller
-
reallocation-operations-controller : Reallocation Operations Controller
-
unit-engineering-unit-controller : Unit Engineering Unit Controller
2. Resources
2.1. Bom-family-controller
Bom Family Controller
2.1.1. Get All BOM Families
GET /bomFamilies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.1.2. Create BOM family
POST /bomFamilies/bomFamilies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.1.3. Get BOM Family by ID
GET /bomFamilies/{bomFamilyId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2. Bom-formulation-controller
Bom Formulation Controller
2.2.1. Create BOM Formulation
POST /formulations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
bomFormulationRequest |
Details on the bom formulation to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.2. Get BOM Formulations
GET /formulations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomFormulationDescription |
bomFormulationDescription to get a list of BOM formulation details. |
string |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
productId |
productID to get a list of BOM formulation details. |
integer (int64) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.3. Get BOM Formulation Item by Id
GET /formulations/items/{formulationItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationItemId |
formulation Item id to get a BOM formulation item |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.4. Get BOM Formulation by Id
GET /formulations/{formulationId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulation id to get a BOM formulation |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.5. Update BOM Formulation
PUT /formulations/{formulationId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulationId to be updated. |
integer (int64) |
Body |
bomFormulationForUpdate |
Details on the bom formulation to update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
204 |
No Content |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.6. Delete BOM Formulation
DELETE /formulations/{formulationId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulationId of the BOM Formulation to be deleted |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
Success |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.7. Create BOM Formulation Items
POST /formulations/{formulationId}/items
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulationId of the BOM Formulation Item to be updated. |
integer (int64) |
Body |
item |
Details on the bom formulation item to create. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Success |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.8. Get BOM items by BOM formulationId
GET /formulations/{formulationId}/items
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulationId to get a list of BOM items |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< BomFormulationItemResult > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.9. Update BOM Formulation Items
PUT /formulations/{formulationId}/items/{formulationItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
formulationId of the BOM Formulation Item to be updated. |
integer (int64) |
Path |
formulationItemId |
bom formulation item id to update. |
integer (int64) |
Body |
item |
Details on the bom formulation item to update. |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.2.10. Delete BOM Formulation Item
DELETE /formulations/{formulationId}/items/{formulationItemId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
formulationId |
ID of the BOM Formulation to be deleted. |
integer (int64) |
Path |
formulationItemId |
ID of the BOM Formulation Item to be deleted. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
Success |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.3. Bom-master-controller
Bom Master Controller
2.3.1. Create BOM Master
POST /bomMasters
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.3.2. Get All BOM Masters
GET /bomMasters
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.3.3. Get BOM Master by ID
GET /bomMasters/{bomMasterId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.4. Consumption-operations-controller
Consumption Operations Controller
2.4.1. Create a consumption record
POST /consumptionOperations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
resourceId |
resourceId |
integer (int32) |
Query |
resourceType |
resourceType |
string |
Body |
consumptionRecord |
consumptionRecord |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.4.2. Get Consumption lots
GET /consumptionOperations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomItemId |
Consumption records for bomItemId. |
integer (int64) |
Query |
id |
ID of consumption record / Component_Id of event_components. |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
segmentId |
Consumption records for segmentId. |
integer (int64) |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
sourceMaterialLotId |
Source Material Lot ID the product being consumed. |
integer (int64) |
Query |
targetMaterialLotId |
Target material Lot IDs the product being manufactured. |
< integer (int64) > array(multi) |
Query |
workOrderId |
Consumption records for workOrderId. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.5. Engineering-units-controller
Engineering Units Controller
2.5.1. Create new uom (engineering units)
POST /engineeringUnits
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.5.2. Get all uom (engineering units)
GET /engineeringUnits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
active |
engineering unit active to get uom details |
boolean |
Query |
code |
engineering unit code to get uom details |
string |
Query |
description |
engineering unit description to get uom details |
string |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.5.3. Get uom (an engineering unit)
GET /engineeringUnits/{engineeringUnitId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
engineeringUnitId |
engineering unit ID to get uom details |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.5.4. Update uom (engineering units)
PUT /engineeringUnits/{engineeringUnitId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
engineeringUnitId |
Engineering Unit Id |
integer (int64) |
Body |
engineeringUnitUpdateInfo |
engineeringUnitUpdateInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.5.5. Delete uom (engineering units) By Id
DELETE /engineeringUnits/{engineeringUnitId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
engineeringUnitId |
Engineering Unit Id |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.6. Material-lot-command-controller
Material Lot Command Controller
2.6.1. Create scrap producton event
POST /materialLots/{materialLotId}/scrap
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId |
integer (int64) |
Body |
materialLotCommandInfo |
materialLotCommandInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7. Material-lot-controller
Material Lot Controller
2.7.1. Create a material lot
POST /materialLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
resourceId |
resourceId |
integer (int32) |
Query |
resourceType |
resourceType |
string |
Body |
materialLotInfo |
materialLotInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.2. Get list of materialLots and their properties
GET /materialLots
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
availableForConsumption |
Status of the item is available for consumption or not. |
boolean |
|
Query |
excludeEmptyLots |
excludeEmptyLots to retrieve properties of materialLots. |
boolean |
|
Query |
includeLotsWithImplicitProduct |
Include Lots With Implicit Product. Default value false productId data populates only from appliedProduct and appliedProduct is not null. True will populates all products and includes implicit products. |
boolean |
|
Query |
lotIdentifier |
lot identifier (use lot_identifier/event_num for this property) |
string |
|
Query |
lotIdentifierPartialSearch |
Whether to do partial match using lotIdentifier param or exact match. Default value false - lotIdentifier param will be used for exact match to Event_Num or lot_Identifier. True - lotIdentifier param will be used for partial match to Event_Num or lot_Identifier |
boolean |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
processOrderId |
Process order id to retreive the material lots. |
integer (int64) |
|
Query |
productId |
Product ID (applied product id) to retrieve properties of materialLots. |
integer (int64) |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
statusIds |
Status Ids (status of the event) |
string |
|
Query |
unitIds |
Unit IDs (ids of the unit the event is for) to retrieve properties of materialLots. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.3. Get the specific materialLot by materialLotId
GET /materialLots/{materialLotId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId to get the specific lot details within that lot. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.4. Update a material lot
PUT /materialLots/{materialLotId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId |
integer (int64) |
Body |
materialLotUpdateInfo |
materialLotUpdateInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.5. Update Material lot Override quantities
POST /materialLots/{materialLotId}/overrideQuantities
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLot id |
integer (int64) |
Body |
materialLotOveQuaRequest |
materialLotOveQuaRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.6. Get list of materialLots properties
GET /materialLots/{materialLotId}/propertyValues
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLot id |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.7.7. update materiallot property values
PUT /materialLots/{materialLotId}/propertyValues
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLot id |
integer (int64) |
Body |
propertyDefinitionInfo |
PropertyDefinitionUpdateInfo |
< ProductPropertyDefinitionUpdateInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PropertyValue > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.8. Material-lot-property-group-controller
Material Lot Property Group Controller
2.8.1. Get property groups of material lot
GET /v1/globalMaterialLotPropertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.8.2. Update material lot property groups
PUT /v1/globalMaterialLotPropertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
materialLotPropertyGroupUpdateInfo |
Property Group Ids |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.9. Material-lot-status-controller
Material Lot Status Controller
2.9.1. Get All MaterialLot Statuses
GET /materialLotStatuses
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLotStatusResult > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.9.2. Get MaterialLot Status by materialLotStatusId
GET /materialLotStatuses/{materialLotStatusId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotStatusId |
MaterialLot Status ID To Get a MaterialLot Status. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.10. Material-traceability-controller
Material Traceability Controller
2.10.1. Create Material Traceability Record
POST /materialTraceabilityRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
materialLotTraceabilityRequest |
materialLotTraceabilityRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.10.2. Get MaterialTraceability Record
GET /materialTraceabilityRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
id |
ID of MaterialTraceabilityRecord / Component_Id of event_components. |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
sourceMaterialLotId |
Source Material Lot ID the Receiver MaterialLot. |
integer (int64) |
Query |
targetMaterialLotId |
Target material Lot IDs non-Receiver MaterialLot. |
< integer (int64) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.11. Product-controller
Product Controller
2.11.1. Create Product
POST /product/v1/products
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.11.2. Get products
GET /product/v1/products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
code |
code |
string |
Query |
description |
description |
string |
Query |
isSerialized |
isSerialized |
boolean |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
productFamilyIds |
productFamilyIds |
string |
Query |
productGroupIds |
productGroupIds |
string |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
unitIds |
Unit Ids of Product. |
< integer (int64) > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.11.3. Get product by ID
GET /product/v1/products/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.11.4. Update Product
PUT /product/v1/products/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
productUpdateInfo |
productUpdateInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.11.5. Delete Product By Id
DELETE /product/v1/products/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.12. Product-execution-path-controller
Product Execution Path Controller
2.12.1. Get product execution paths
GET /product/v1/executionPaths
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.12.2. Get active product execution paths for given productId
GET /product/v1/products/{id}/executionPaths
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.12.3. Associate/Disassociate product to execution path(s)
PATCH /product/v1/products/{id}/productExecutionPath
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
pathIds |
pathIds |
< integer (int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.13. Product-family-controller
Product Family Controller
2.13.1. Create Product Family
POST /product/v1/productFamilies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.13.2. Get product families
GET /product/v1/productFamilies
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
productId |
productId |
integer (int64) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.13.3. Get product family by ID
GET /product/v1/productFamilies/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.13.4. Update Product Family
PUT /product/v1/productFamilies/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Query |
description |
description |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.13.5. Delete Product Family By Id
DELETE /product/v1/productFamilies/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.14. Product-group-controller
Product Group Controller
2.14.1. Get product groups
GET /product/v1/productGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
productId |
productId |
integer (int64) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.14.2. Get product group by ID
GET /product/v1/productGroups/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.15. Product-property-group-controller
Product Property Group Controller
2.15.1. Get property groups of product
GET /v1/globalProductPropertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.15.2. Update property groups
PUT /v1/globalProductPropertyGroups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
propertyGroupUpdateInfo |
Property Group Ids |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.16. Product-property-value-controller
Product Property Value Controller
2.16.1. Get property value for product
GET /v1/products/{productId}/propertyValues
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
productId |
product id |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.16.2. update property values
PUT /v1/products/{productId}/propertyValues
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
productId |
product id |
integer (int64) |
Body |
propertyDefinitionUpdateInfo |
PropertyDefinitionUpdateInfo |
< ProductPropertyDefinitionUpdateInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PropertyValue > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessible Entity |
No Content |
500 |
Internal Server Error |
|
503 |
Service Unavailable |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.17. Product-unit-controller
Product Unit Controller
2.17.1. Get product units
GET /product/v1/productUnits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
departmentIds |
departmentIds |
string |
Query |
lineIds |
lineIds |
string |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
productIds |
productIds |
string |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.17.2. Get product unit by ID
GET /product/v1/productUnits/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.17.3. Associate/Disassociate product to production unit(s)
PATCH /product/v1/products/{id}/productUnits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
unitIds |
unitIds |
< integer (int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.18. Reallocation-operations-controller
Reallocation Operations Controller
2.18.1. Check originMaterialLotId is having single or multiple source lot
GET /checkMultipleSourceLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomItemId |
bomItemId |
integer (int64) |
Query |
originMaterialLotId |
originMaterialLotId Lot Id |
integer (int64) |
Query |
segmentId |
segmentId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
boolean |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.18.2. Get Reallocation BOM Genealogy consumption records
GET /reallocation/genealogy
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomItemId |
Consumption records for bomItemId. |
integer (int64) |
Query |
segmentId |
Consumption records for segmentId. |
integer (int64) |
Query |
sourceMaterialLotId |
Source Material Reallocation Lot ID the product being consumed. |
integer (int64) |
Query |
workOrderId |
Consumption records for workOrderId. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ConsumedLotInfo > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.18.3. Reallocation Operations
POST /reallocationOperations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
resourceId |
resourceId |
integer (int32) |
Query |
resourceType |
resourceType |
string |
Body |
reallocationOperationsRequest |
reallocationOperationsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
503 |
Service Unavailable |
No Content |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
2.19. Unit-engineering-unit-controller
Unit Engineering Unit Controller
2.19.1. Get Engineering unit associated to Unit id
GET /units/{unitId}/engineeringUnits
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
Security
| Type | Name | Scopes |
|---|---|---|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
oauth2 |
mes.materiallot.create,mes.consumptionoperations.edit |
|
apiKey |
mes.materiallot.create,mes.consumptionoperations.edit |
3. Definitions
3.1. BomFamily
| Name | Description | Schema |
|---|---|---|
description |
The BOM family’s description |
string |
id |
The unique Id of the BOM family |
integer (int64) |
links |
< Link > array |
3.2. BomFamilyCreateInfo
| Name | Description | Schema |
|---|---|---|
description |
The BOM family’s description |
string |
3.3. BomFamilyInfo
| Name | Description | Schema |
|---|---|---|
description |
The BOM family’s description |
string |
id |
The unique Id of the BOM family |
integer (int64) |
3.4. BomFamilyPage
| Name | Schema |
|---|---|
content |
< BomFamily > array |
links |
< Link > array |
page |
3.5. BomFormulationForCreate
| Name | Description | Schema |
|---|---|---|
bomMasterId |
Bom formulation Master BOM Id. |
integer (int32) |
description |
BOM Formulation description. |
string |
effectiveDate |
Effective date and time of the formulation. |
string (date-time) |
expirationDate |
Date and time at which the formulation will expire. |
string (date-time) |
productIds |
Associated products with the formulation. |
< integer (int64) > array |
quantityPrecision |
The number of decimal places to which the Quantity will be displayed. |
integer (int32) |
standardQuantity |
Quantity this formulation produces. |
number (double) |
uom |
Units of measure used in Quantity. |
integer (int64) |
3.6. BomFormulationForUpdate
| Name | Description | Schema |
|---|---|---|
bomMasterId |
Bom formulation Master BOM Id. |
integer (int32) |
description |
BOM Formulation description. |
string |
effectiveDate |
Effective date and time of the formulation. |
string (date-time) |
expirationDate |
Date and time at which the formulation will expire. |
string (date-time) |
id |
BOM Formulation id to update. |
integer (int64) |
productIds |
Associated products with the formulation. |
< integer (int64) > array |
quantityPrecision |
The number of decimal places to which the Quantity will be displayed. |
integer (int32) |
standardQuantity |
Quantity this formulation produces. |
number (double) |
uom |
Units of measure used in Quantity. |
integer (int64) |
3.7. BomFormulationInfo
| Name | Description | Schema |
|---|---|---|
bomMasterId |
Bom formulation Master BOM Id. |
integer (int32) |
createdBy |
User that created the formulation |
string |
createdOn |
Date that the formulation was created. |
string (date-time) |
description |
Formulation description of a BOM |
string |
effectiveDate |
Formulation effective date |
string (date-time) |
expirationDate |
Formulation expiration date |
string (date-time) |
id |
BOM Formulation id |
integer (int64) |
lastModifiedBy |
User that last modified the formulation. |
string |
lastModifiedOn |
Date that the formulation was last modified. |
string (date-time) |
productIds |
Associated products with the formulation. |
< integer (int64) > array |
quantityPrecision |
Quantity Precision |
integer (int32) |
standardQuantity |
standard quantity |
number (double) |
uom |
Eng unit Id |
integer (int64) |
3.8. BomFormulationInfoResult
| Name | Description | Schema |
|---|---|---|
bomMasterId |
Bom formulation Master BOM Id. |
integer (int32) |
createdBy |
User that created the formulation |
string |
createdOn |
Date that the formulation was created. |
string (date-time) |
description |
Formulation description of a BOM |
string |
effectiveDate |
Formulation effective date |
string (date-time) |
expirationDate |
Formulation expiration date |
string (date-time) |
id |
BOM Formulation id |
integer (int64) |
lastModifiedBy |
User that last modified the formulation. |
string |
lastModifiedOn |
Date that the formulation was last modified. |
string (date-time) |
links |
< Link > array |
|
productIds |
Associated products with the formulation. |
< integer (int64) > array |
quantityPrecision |
Quantity Precision |
integer (int32) |
standardQuantity |
standard quantity |
number (double) |
uom |
Eng unit Id |
integer (int64) |
3.9. BomFormulationInfoResults
| Name | Schema |
|---|---|
content |
< BomFormulationInfoResult > array |
links |
< Link > array |
page |
3.10. BomFormulationItem
| Name | Description | Schema |
|---|---|---|
alias |
bom formulation item alias |
string |
id |
Bom Formulation Item id |
integer (int64) |
itemOrder |
BOM Formulation Order |
integer (int64) |
lowerTolerance |
Lower Tolerance |
number (double) |
lowerTolerancePrecision |
bom formulation item lower Tolerance Precision |
integer (int32) |
productId |
Product id |
integer (int64) |
quantity |
Quantity of a BOM Formulationss |
number (double) |
quantityPrecision |
bom formulation Quantity Precision |
integer (int32) |
scrapFactor |
bom formulation item scrap factor |
number (double) |
storageUnit |
Storage Unit - PU |
integer (int64) |
uom |
Eng Unit Id |
integer (int64) |
upperTolerance |
Upper Tolerance |
number (double) |
upperTolerancePrecision |
bom formulation item upper Tolerance Precision |
integer (int32) |
3.11. BomFormulationItemForCreate
| Name | Description | Schema |
|---|---|---|
alias |
bom formulation item alias |
string |
lowerTolerance |
The minimum quantity, measured in the selected engineering units, of the formulation item that must be used in the formulation. |
number (double) |
lowerTolerancePrecision |
The number of decimal places to which the Lower Tolerance will be displayed. |
integer (int32) |
productId |
Product id to add to the formulation. |
integer (int64) |
quantity |
Quantity of selected product used in this formulation. |
number (double) |
quantityPrecision |
The number of decimal places to which the Quantity will be displayed. |
integer (int32) |
scrapFactor |
Percentage of this formulation item that is expected to be lost during production of the formulation. For example, if 100 units of Product XYZ is required with a scrap factor of 1%, then you should have a 101 units on hand when preparing to produce the product. |
number (double) |
storageUnit |
Unit currently storing the selected product. |
integer (int64) |
uom |
Engineering units used to measure Quantity. |
integer (int64) |
upperTolerance |
The maximum quantity, measured in the selected engineering units, of the formulation item that can be used in the formulation. |
number (double) |
upperTolerancePrecision |
The number of decimal places to which the Upper Tolerance will be displayed. |
integer (int32) |
3.12. BomFormulationItemForUpdate
| Name | Description | Schema |
|---|---|---|
alias |
bom formulation item alias |
string |
id |
bom formulation item id to update. |
integer (int64) |
lowerTolerance |
The minimum quantity, measured in the selected engineering units, of the formulation item that must be used in the formulation. |
number (double) |
lowerTolerancePrecision |
The number of decimal places to which the Lower Tolerance will be displayed. |
integer (int32) |
productId |
Product id to add to the formulation. |
integer (int64) |
quantity |
Quantity of selected product used in this formulation. |
number (double) |
quantityPrecision |
The number of decimal places to which the Quantity will be displayed. |
integer (int32) |
scrapFactor |
Percentage of this formulation item that is expected to be lost during production of the formulation. For example, if 100 units of Product XYZ is required with a scrap factor of 1%, then you should have a 101 units on hand when preparing to produce the product. |
number (double) |
storageUnit |
Unit currently storing the selected product. |
integer (int64) |
uom |
Engineering units used to measure Quantity. |
integer (int64) |
upperTolerance |
The maximum quantity, measured in the selected engineering units, of the formulation item that can be used in the formulation. |
number (double) |
upperTolerancePrecision |
The number of decimal places to which the Upper Tolerance will be displayed. |
integer (int32) |
3.13. BomFormulationItemResult
| Name | Description | Schema |
|---|---|---|
alias |
bom formulation item alias |
string |
bomFormulationItemId |
integer (int64) |
|
id |
Bom Formulation Item id |
integer (int64) |
itemOrder |
BOM Formulation Order |
integer (int64) |
links |
< Link > array |
|
lowerTolerance |
Lower Tolerance |
number (double) |
lowerTolerancePrecision |
bom formulation item lower Tolerance Precision |
integer (int32) |
productId |
Product id |
integer (int64) |
quantity |
Quantity of a BOM Formulationss |
number (double) |
quantityPrecision |
bom formulation Quantity Precision |
integer (int32) |
scrapFactor |
bom formulation item scrap factor |
number (double) |
storageUnit |
Storage Unit - PU |
integer (int64) |
uom |
Eng Unit Id |
integer (int64) |
upperTolerance |
Upper Tolerance |
number (double) |
upperTolerancePrecision |
bom formulation item upper Tolerance Precision |
integer (int32) |
3.14. BomMaster
| Name | Description | Schema |
|---|---|---|
active |
boolean |
|
bomFamilyId |
The BOM Family Id |
integer (int32) |
description |
The BOM description |
string |
id |
The unique Id of the BOM |
integer (int64) |
links |
< Link > array |
3.15. BomMasterPage
| Name | Schema |
|---|---|
content |
< BomMaster > array |
links |
< Link > array |
page |
3.16. BomMasterRequest
| Name | Description | Schema |
|---|---|---|
description |
Description |
string |
familyId |
Family Id |
integer (int32) |
3.17. BomMasterResponse
| Name | Description | Schema |
|---|---|---|
description |
The BOM Master description |
string |
id |
The unique Id of the BOM Master |
integer (int64) |
3.18. ConsumedLotInfo
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
entryOn |
Lot Entry On |
string (date-time) |
id |
Consumption Record ID / event component ID |
integer (int64) |
lotIdentifier |
Lot Identifier |
string |
productId |
Product ID / Applied Product ID |
integer (int64) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
timeStamp |
Lot Timestamp |
string (date-time) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
userId |
PA UserId |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.19. ConsumptionOperationRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom item ID |
integer (int64) |
consumedQuantity |
Consumed quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
targetMaterialLotId |
Target material lot ID |
integer (int64) |
unitOfMeasureId |
Unit of measureId ID |
integer (int64) |
workOrderId |
Work order ID |
integer (int64) |
3.20. ConsumptionRecord
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
id |
Consumption Record ID / event component ID |
integer (int64) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.21. ConsumptionRecordInfo
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
entryOn |
Lot Entry On |
string (date-time) |
id |
Consumption Record ID / event component ID |
integer (int64) |
links |
< Link > array |
|
lotIdentifier |
Lot Identifier |
string |
productId |
Product ID / Applied Product ID |
integer (int64) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
timeStamp |
Lot Timestamp |
string (date-time) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
userId |
PA UserId |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.22. ConsumptionRecordInfoPage
| Name | Schema |
|---|---|
content |
< ConsumptionRecordInfo > array |
links |
< Link > array |
page |
3.23. ConsumptionRecordRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.24. DimensionalQuantity
| Name | Description | Schema |
|---|---|---|
currentQuantity |
Current Quantity of lot / Final Dimension |
number (float) |
dimension |
Dimension to which to which it belongs |
string |
dimensionName |
Dimension name of Subtype |
string |
initialQuantity |
Initial Quantity of lot for / Initial Dimension |
number (double) |
unitOfMeasureId |
Unit Of Measure ID |
integer (int64) |
3.25. EngineeringUnitForCreate
| Name | Description | Schema |
|---|---|---|
code |
Engineering Unit code |
string |
description |
Engineering Unit description |
string |
3.26. EngineeringUnitForUpdate
| Name | Description | Schema |
|---|---|---|
code |
Engineering Unit code |
string |
description |
Engineering Unit description |
string |
id |
Engineering Unit id to update |
integer (int64) |
3.29. Link
| Name | Schema |
|---|---|
deprecation |
string |
href |
string |
hreflang |
string |
media |
string |
name |
string |
profile |
string |
rel |
string |
template |
|
templated |
boolean |
title |
string |
type |
string |
3.30. MaterialLotCommandInfo
Create scrap production event.
| Name | Description | Schema |
|---|---|---|
quanity |
number (float) |
|
reasonLevel1 |
The value of reasonLevel1 |
integer (int64) |
reasonLevel2 |
The value of reasonLevel2 |
integer (int64) |
reasonLevel3 |
The value of reasonLevel3 |
integer (int64) |
reasonLevel4 |
The value of reasonLevel4 |
integer (int64) |
statusId |
The value of status Id |
integer (int64) |
3.31. MaterialLotInfo
| Name | Description | Schema |
|---|---|---|
initialQuantity |
Initial Quantity of lot / Initial Dimension X |
number (double) |
lotIdentifier |
Lot Identifier / Event Num |
string |
productId |
Product ID / Applied Product ID |
integer (int64) |
statusId |
Lot status / Event Status |
integer (int64) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit Of Measure ID |
integer (int64) |
3.32. MaterialLotInfoResult
| Name | Description | Schema |
|---|---|---|
availableForConsumption |
Is Available For Consumption |
boolean |
currentQuantity |
Current Quantity of lot / Final Dimension X |
number (float) |
dimension |
Dimension to which to which it belongs |
string |
dimensionName |
Dimension name of Subtype |
string |
dimensionalQuantities |
Collection of Dimensional quantities A,X,Y,Z |
< DimensionalQuantity > array |
id |
Material Lot ID / Event ID |
integer (int64) |
initialQuantity |
Initial Quantity of lot / Initial Dimension X |
number (double) |
links |
< Link > array |
|
lotIdentifier |
Lot Identifier / Event Num |
string |
processOrderId |
ID of process order / pp_id |
integer (int64) |
productId |
Product ID / Applied Product ID |
integer (int64) |
statusId |
Lot status / Event Status |
integer (int64) |
timeStamp |
Time when the lot was created. |
string (date-time) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit Of Measure ID |
integer (int64) |
userId |
UserId of the user who created the lot. |
integer (int64) |
3.33. MaterialLotInfoResults
| Name | Schema |
|---|---|
content |
< MaterialLotInfoResult > array |
links |
< Link > array |
page |
3.34. MaterialLotOverrideQuantitiyRequest
| Name | Description | Schema |
|---|---|---|
existingCurrentQuantity |
Existing Current Quantity of lot / Final Dimension X |
number (float) |
existingInitialQuantity |
Existing Initial Quantity of lot / Initial Dimension X |
number (double) |
newCurrentQuantity |
New Current Quantity of lot / Final Dimension X |
number (float) |
newInitialQuantity |
New Initial Quantity of lot / Initial Dimension X |
number (double) |
3.35. MaterialLotOverrideQuantitiyResponseResult
| Name | Description | Schema |
|---|---|---|
currentQuantity |
Current Quantity of lot / Final Dimension X |
number (float) |
id |
Material Lot ID / Event ID |
integer (int64) |
initialQuantity |
Initial Quantity of lot / Initial Dimension X |
number (double) |
links |
< Link > array |
3.36. MaterialLotPropertyDefinitionInfo
Material Lot Property Value Data Transfer Object
| Name | Description | Schema |
|---|---|---|
propertyDefinitionId |
The id of the property |
string |
propertyValue |
The value of the property |
string |
3.37. MaterialLotPropertyGroupInfo
MaterialLot Property Groups Data Transfer Object
| Name | Schema |
|---|---|
id |
string |
3.38. MaterialLotPropertyResult
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
propertyDefinitionId |
The id of the property |
string |
propertyValue |
The value of the property |
string |
3.39. MaterialLotPropertyResults
| Name | Schema |
|---|---|
content |
< MaterialLotPropertyResult > array |
links |
< Link > array |
page |
3.40. MaterialLotStatus
| Name | Description | Schema |
|---|---|---|
description |
MaterialLot Status Description |
string |
id |
MaterialLot Status ID / Event Status |
integer (int64) |
isGoodStatus |
Is Quality Good |
boolean |
isInventoryStatus |
Is Inventory |
boolean |
isProductionStatus |
Is Production |
boolean |
3.41. MaterialLotStatusResult
| Name | Description | Schema |
|---|---|---|
description |
MaterialLot Status Description |
string |
id |
MaterialLot Status ID / Event Status |
integer (int64) |
isGoodStatus |
Is Quality Good |
boolean |
isInventoryStatus |
Is Inventory |
boolean |
isProductionStatus |
Is Production |
boolean |
links |
< Link > array |
3.42. MaterialLotUpdateInfo
| Name | Description | Schema |
|---|---|---|
lotIdentifier |
Lot Identifier / event_num |
string |
statusId |
Lot status / event_status |
integer (int64) |
3.43. MaterialTraceabilityInfo
| Name | Description | Schema |
|---|---|---|
consumedQuantity |
Consumed Quantity |
number (double) |
id |
event Component Id |
integer (int64) |
links |
< Link > array |
|
productId |
Product ID / Applied Product ID |
integer (int64) |
sourceLotIdentifier |
Source Lot Identifier/Event_Num |
string |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
unitId |
Unit ID / PU ID |
integer (int64) |
3.44. MaterialTraceabilityRecord
| Name | Description | Schema |
|---|---|---|
consumedQuantity |
Consumed Quantity |
number (double) |
id |
event component ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
3.45. MaterialTraceabilityRecordInfoPage
| Name | Schema |
|---|---|
content |
< MaterialTraceabilityInfo > array |
links |
< Link > array |
page |
3.46. MaterialTraceabilityRequest
| Name | Description | Schema |
|---|---|---|
childUnitId |
Child UnitId |
number (double) |
consumedQuantity |
Consumed Quantity |
number (double) |
dimensionA |
Dimension A |
number (double) |
dimensionY |
Dimension Y |
number (double) |
dimensionZ |
Dimension Z |
number (double) |
extendedInfo |
extended_Info |
string |
pEIId |
PEI_Id |
number (double) |
parentComponentId |
parent Component Id |
number (double) |
reportAsConsumption |
ReportAsConsumption |
number (double) |
sendPost |
SendPost |
number (double) |
signatureId |
Signature_id |
number (double) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
startCoordinateA |
Start_Coordinate_A |
number (double) |
startCoordinateX |
Start_coordinate _x |
number (double) |
startCoordinateY |
Start_coordinate _Y |
number (double) |
startCoordinateZ |
Start_Coordinate_Z |
number (double) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
3.47. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.48. Product
| Name | Description | Schema |
|---|---|---|
code |
The product code |
string |
description |
The description of the product |
string |
descriptionGlobal |
The description of the product global |
string |
eventEsignatureLevel |
The event Esiganature level |
integer (int64) |
externalLink |
Product External Link |
string |
id |
The unique ID of the product |
integer (int64) |
isSerialized |
The product Id is serialized or not |
boolean |
links |
< Link > array |
|
productChangeEsignatureLevel |
The product change Esiganature level |
integer (int64) |
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
productGroupId |
The id of the product group this product is a member of |
integer (int64) |
3.49. ProductCreateInfo
| Name | Description | Schema |
|---|---|---|
code |
The product code |
string |
description |
The description of the product |
string |
descriptionGlobal |
The description of the product global |
string |
eventEsignatureLevel |
The event Esiganature level |
integer (int64) |
externalLink |
Product External Link |
string |
isSerialized |
The product Id is serialized or not |
boolean |
productChangeEsignatureLevel |
The product change Esiganature level |
integer (int64) |
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
3.50. ProductExecutionPath
| Name | Description | Schema |
|---|---|---|
id |
The unique Id of the product execution path products |
integer (int64) |
links |
< Link > array |
|
pathCode |
Path Code |
string |
pathDescription |
Path Description |
string |
plId |
PL Id |
integer (int64) |
3.51. ProductExecutionPathInfo
| Name | Description | Schema |
|---|---|---|
id |
The unique Id of the product execution path products |
integer (int64) |
pathCode |
Path Code |
string |
pathDescription |
Path Description |
string |
plId |
PL Id |
integer (int64) |
3.52. ProductExecutionPathPage
| Name | Schema |
|---|---|
content |
< ProductExecutionPathInfo > array |
links |
< Link > array |
page |
3.53. ProductFamily
| Name | Description | Schema |
|---|---|---|
description |
The product family’s description |
string |
id |
The unique Id of the product family |
integer (int64) |
links |
< Link > array |
3.54. ProductFamilyInfo
| Name | Description | Schema |
|---|---|---|
description |
The product family’s description |
string |
id |
The unique Id of the product family |
integer (int64) |
3.55. ProductFamilyPage
| Name | Schema |
|---|---|
content |
< ProductFamily > array |
links |
< Link > array |
page |
3.56. ProductGroup
| Name | Description | Schema |
|---|---|---|
description |
The property group’s description |
string |
links |
< Link > array |
|
productGroupId |
The unique Id of the product group |
integer (int64) |
3.57. ProductGroupPage
| Name | Schema |
|---|---|
content |
< ProductGroup > array |
links |
< Link > array |
page |
3.58. ProductInfo
| Name | Description | Schema |
|---|---|---|
code |
The product code |
string |
description |
The description of the product |
string |
descriptionGlobal |
The description of the product global |
string |
eventEsignatureLevel |
The event Esiganature level |
integer (int64) |
externalLink |
Product External Link |
string |
id |
The unique ID of the product |
integer (int64) |
isSerialized |
The product Id is serialized or not |
boolean |
productChangeEsignatureLevel |
The product change Esiganature level |
integer (int64) |
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
productGroupId |
The id of the product group this product is a member of |
integer (int64) |
3.59. ProductPage
| Name | Schema |
|---|---|
content |
< Product > array |
links |
< Link > array |
page |
3.60. ProductPropertyDefinitionUpdateInfo
Product Property Value Data Transfer Object
| Name | Description | Schema |
|---|---|---|
propertyDefinitionId |
The id of the property |
string |
propertyValue |
The value of the property |
string |
3.61. ProductPropertyGroupInfo
Product Property Groups Data Transfer Object
| Name | Schema |
|---|---|
id |
string |
3.62. ProductUnit
| Name | Description | Schema |
|---|---|---|
departmentId |
The ID of the department |
integer (int64) |
engUnitId |
The unique ID of the engineering unit |
integer (int64) |
lineId |
The ID of the department |
integer (int64) |
links |
< Link > array |
|
productId |
The unique ID of the department |
integer (int64) |
productUnitId |
The ID of the production unit |
string |
unitId |
The ID of the unit |
integer (int64) |
3.63. ProductUnitPage
| Name | Schema |
|---|---|
content |
< ProductUnit > array |
links |
< Link > array |
page |
3.64. ProductUpdateInfo
| Name | Description | Schema |
|---|---|---|
code |
The product code |
string |
descriptionGlobal |
The description of the product global |
string |
eventEsignatureLevel |
The event Esiganature level |
integer (int64) |
externalLink |
Product External Link |
string |
productChangeEsignatureLevel |
The product change Esiganature level |
integer (int64) |
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
3.65. PropertyGroup
| Name | Schema |
|---|---|
id |
string |
links |
< Link > array |
propertyGroupId |
string |
3.66. PropertyGroupPage
| Name | Schema |
|---|---|
id |
string |
links |
< Link > array |
propertyGroupId |
string |
3.67. PropertyValue
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
propertyDefinitionId |
The id of the property |
string |
propertyValue |
The value of the property |
string |
3.68. PropertyValuePage
| Name | Schema |
|---|---|
content |
< PropertyValue > array |
links |
< Link > array |
page |
3.69. ReallocationOperationRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom item ID |
integer (int64) |
consumptionOperations |
Consumption operations list |
< ConsumptionOperationRequest > array |
reallocatedQuantity |
Re allocated quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source MaterialLot ID |
integer (int64) |
unitOfMeasureId |
Unit of measure ID |
integer (int64) |
3.70. ReallocationOperationResponse
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom item ID |
integer (int64) |
consumptionOperations |
Consumption operations list |
< ConsumptionRecord > array |
reallocatedQuantity |
Re allocated quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source MaterialLot ID |
integer (int64) |
unitOfMeasureId |
Unit of measure ID |
integer (int64) |
3.71. ReallocationOperationsRequest
| Name | Description | Schema |
|---|---|---|
originMaterialLotId |
Target material lot ID |
integer (int64) |
reallocationOperations |
Reallocation operations list |
< ReallocationOperationRequest > array |
workOrderId |
Work order ID |
integer (int64) |
3.72. ReallocationOperationsResponse
| Name | Description | Schema |
|---|---|---|
originMaterialLotId |
Target material lot ID |
integer (int64) |
reallocationOperations |
Reallocation operations list |
< ReallocationOperationResponse > array |
workOrderId |
Work order ID |
integer (int64) |
3.73. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.75. UnitEngineeringUnit
| Name | Description | Schema |
|---|---|---|
engUnitId |
The unique ID of the engineering unit |
integer (int64) |
links |
< Link > array |
|
unitId |
The ID of the unit |
integer (int64) |
3.76. UnitOfMeasure
| Name | Description | Schema |
|---|---|---|
active |
Active |
boolean |
code |
Engineering Unit code |
string |
description |
Engineering Unit description |
string |
engUnitId |
Engineering Unit id |
integer (int64) |
links |
< Link > array |
3.77. UnitOfMeasurePage
| Name | Schema |
|---|---|
content |
< UnitOfMeasure > array |
links |
< Link > array |
page |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://localhost:8443/uaa/oauth/authorize
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
mes.materiallot.create |
Core service permissions to create material lot |
mes.consumptionoperations.edit |
Core service permission to create and edit consumption operations for raw material genealogy |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
mes.materiallot.create |
Core service permissions to create material lot |
mes.consumptionoperations.edit |
Core service permission to create and edit consumption operations for raw material genealogy |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost:8443/uaa/oauth/authorize
| Name | Description |
|---|---|
mes.materiallot.create |
Core service permissions to create material lot |
mes.consumptionoperations.edit |
Core service permission to create and edit consumption operations for raw material genealogy |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
mes.materiallot.create |
Core service permissions to create material lot |
mes.consumptionoperations.edit |
Core service permission to create and edit consumption operations for raw material genealogy |