1. Overview
Microservice containing the business logic for managing inspection-service. Descriptions of these functions can be found in the section headers for each collection of relevant resources.
1.3. Tags
-
material-lot-controller : Material Lot Controller
-
receiver-material-lots-controller : Receiver Material Lots Controller
-
sample-material-lot-controller : Sample Material Lot Controller
-
test-material-lot-controller : Test Material Lot Controller
-
units-controller : Units Controller
-
variables-controller : Variables Controller
2. Resources
2.1. Material-lot-controller
Material Lot Controller
2.1.1. Validating the MaterialLot Names sent for a given Planned Unit Id
POST /v1.0/materialLots/validate
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.1.2. updateMaterialLotQuantity
PUT /v1.0/materialLots/{materialLotId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId |
integer (int64) |
Body |
updateInfo |
updateInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.1.3. Update the final dimension x and status based on disposition type
PUT /v1.0/materialLots/{materialLotId}/disposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId |
integer (int64) |
Body |
dispositionInfoList |
dispositionInfoList |
< DispositionInfo > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.2. Receiver-material-lots-controller
Receiver Material Lots Controller
2.2.1. Get All MaterialLots
GET /v1.0/receiverMaterialLots
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
searchText |
searchText |
string |
|
Query |
status |
status |
enum (OPEN, CLOSE) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ReceiverMaterialLots > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.2. Get MaterialLots Based on materialLotIds. This is an NC specific end endpoint
GET /v1.0/receiverMaterialLots/materialLots
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
materialLotIds |
materialLot id to filter recevicer material lots |
< integer (int64) > array(multi) |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLots > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.3. Get Material Lots of a Receiver. This is an NC specific end endpoint
GET /v1.0/receiverMaterialLots/nonconformance/{receivernumber}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< MaterialLotsInfoNC > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.4. Get All productionStatus
GET /v1.0/receiverMaterialLots/productionStatus
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ProductionStatus > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.5. Get Receivers by search
GET /v1.0/receiverMaterialLots/receiversSearch
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
searchText |
searchText |
string |
|
Query |
status |
status |
enum (OPEN, CLOSE) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ReceiverInfo > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.6. Get All MaterialLots Based on receiverId
GET /v1.0/receiverMaterialLots/{receiverId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ReceiverMaterialLots > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.3. Sample-material-lot-controller
Sample Material Lot Controller
2.3.1. Create sample material lot
POST /v1.0/samples
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
2.3.2. Get Samples By MaterialLot Ids
GET /v1.0/samples
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
materialLotIds |
materialLotIds with comma separated |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< RetrieveSamplesInfo > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.3.3. Update sample material lot
PUT /v1.0/samples/{sampleId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
sampleId |
sampleId |
integer (int64) |
Body |
sampleUpdateInfo |
Sample Description |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.3.4. Delete Sample
DELETE /v1.0/samples/{sampleId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.4. Test-material-lot-controller
Test Material Lot Controller
2.4.1. Create test
POST /v1.0/tests
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 |
2.4.2. Get Tests
GET /v1.0/tests
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< TestMaterialLotInfoWrapper > array |
400 |
BadRequest |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
500 |
Internal server error |
No Content |
2.4.3. Update test
PUT /v1.0/tests/{testId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
testId |
testId |
integer (int64) |
Body |
testMaterialLotInfo |
testMaterialLotInfo |
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 |
2.5. Units-controller
Units Controller
2.5.1. Retrieving All transaction statuses for a given Unit ID and Status ID (Optional)
GET /v1.0/units/{unitId}/prodExecutionTransitions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
unitId |
unitId |
integer (int64) |
Query |
statusIds |
statusIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.6. Variables-controller
Variables Controller
2.6.1. Get Variables
GET /v1.0/variables
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
materialId |
materialId |
integer (int64) |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Variables > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.6.2. Get DataTypes
GET /v1.0/variables/dataTypes
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DataTypes > array |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
3. Definitions
3.3. Error
Error details.
| Name | Description | Schema |
|---|---|---|
code |
string |
|
details |
Details of the error. |
object |
3.4. HttpErrorResponse
Http Error response.
| Name | Description | Schema |
|---|---|---|
error |
Error details |
|
path |
URL at which error occured. |
string |
timestamp |
Timestamp at which error occured |
string |
3.6. MaterialLotUpdateInfo
| Name | Description | Schema |
|---|---|---|
eventId |
eventId |
integer (int64) |
eventNum |
event_num |
string |
finalDimensionx |
finalDimensionx |
number (float) |
initialDimensionx |
initialDimensionx |
number (float) |
3.8. MaterialLots
| Name | Schema |
|---|---|
commentId |
integer (int64) |
isSerialized |
boolean |
lineId |
integer (int64) |
lotIdentifier |
string |
materialLotStatus |
string |
materialLotStatusId |
integer (int64) |
materialLotsEntryOn |
string |
productId |
integer (int64) |
quantity |
integer (int64) |
receiverId |
integer (int64) |
receiverNumber |
string |
targetEventId |
integer (int64) |
unitId |
integer (int64) |
3.9. MaterialLotsInfoNC
| Name | Schema |
|---|---|
eventId |
integer (int64) |
eventNum |
string |
unitId |
integer (int64) |
3.10. ProductionStatus
| Name | Schema |
|---|---|
colorId |
integer (int64) |
iconId |
integer (int64) |
id |
integer (int64) |
lifeCycleStage |
integer (int64) |
prodStatusDesc |
string |
prodStatusDescLocal |
string |
3.11. ReceiverInfo
| Name | Schema |
|---|---|
productCode |
string |
productId |
integer (int64) |
receiverNumber |
string |
receiverStatus |
string |
sourceEventId |
integer (int64) |
3.12. ReceiverMaterialLots
| Name | Description | Schema |
|---|---|---|
materialLots |
< MaterialLots > array |
|
receiverNumber |
receiverNumber |
string |
receiverStatus |
receiverStatus |
string |
receiverStatusId |
receiverStatusId |
integer (int64) |
receiverUnitId |
receiverUnitId |
integer (int64) |
sourceEventId |
sourceEventId |
integer (int64) |
timeStampValue |
timeStampValue |
string |
3.13. RetrieveSamplesInfo
Retrive Samples Data Transfer Object
| Name | Schema |
|---|---|
autoGeneratedSample |
boolean |
commentId |
integer (int64) |
endTime |
string |
materialLotId |
integer (int64) |
sampleId |
integer (int64) |
sampleName |
string |
unitId |
integer (int64) |
3.14. SampleMaterialLotInfo
Sample material lot.
| Name | Description | Schema |
|---|---|---|
materialLotId |
The Id of Material Lot |
integer (int64) |
sampleName |
The name of Sample Material Lot |
string |
3.15. SampleMaterialLotResult
Get Sample material lot.
| Name | Description | Schema |
|---|---|---|
endTime |
The end time of the Sample |
string |
materialLotId |
The Id of the Sample Material Lot |
integer (int64) |
receiverId |
The Id of the parent receiver |
integer (int64) |
sampleId |
The Id of the Sample |
integer (int64) |
sampleName |
The name of the Sample |
string |
startTime |
The start time of the Sample |
string |
unitId |
The Id of the Sample Material Lot |
integer (int64) |
3.16. SampleMaterialLotUpdateInfo
Sample update data tranfer object
| Name | Description | Schema |
|---|---|---|
sampleName |
Name of the sample |
string |
3.17. StatusCombination
| Name | Schema |
|---|---|
fromStatusDescription |
string |
fromStatusId |
integer (int32) |
toStatusDescription |
string |
toStatusId |
integer (int32) |
3.18. TestMaterialLotInfo
Create Tests info .
| Name | Description | Schema |
|---|---|---|
eventId |
event Id can be either production event or sample id |
integer (int64) |
testValue |
Name of test value |
string |
variableId |
Variable Id |
integer (int32) |
3.19. TestMaterialLotInfoWrapper
Get Test material lot.
| Name | Description | Schema |
|---|---|---|
cancelled |
Cancelled |
boolean |
commentId |
Comment Id |
string |
resultOn |
result On |
string |
sampleId |
Sample Id |
integer (int64) |
specDesc |
Specification Name |
string |
testId |
Test Id |
integer (int64) |
testValue |
Name of test value |
string |
varPrecision |
Variable Precision |
integer (int32) |
variableId |
Variable Id |
integer (int32) |
3.20. TestMaterialLotResult
| Name | Description | Schema |
|---|---|---|
cancelled |
Cancelled |
boolean |
eventId |
Event Id |
integer (int64) |
resultOn |
result On |
string |
testId |
Test Id |
integer (int64) |
testValue |
Name of test value |
string |
variableId |
Variable Id |
integer (int32) |
3.21. TransactionStatus
| Name | Schema |
|---|---|
links |
< Link > array |
plannedUnitId |
integer (int64) |
prodExecutionTransitions |
< StatusCombination > array |
3.22. ValidationRequestInfo
Validate MaterialLots request data transfer object
| Name | Description | Schema |
|---|---|---|
materialLotNames |
List of materialLot names |
< string > array |
newLotStatusId |
Status ID of the material lot to be updated |
integer (int32) |
plannedUnitId |
plannedUnitId |
integer (int64) |
productId |
productId |
integer (int32) |
transNum |
TransNum value to determine the type of validation to perform |
enum (1, 2) |
3.23. ValidationResponse
| Name | Schema |
|---|---|
errorCode |
string |
errorMessage |
string |
eventNumberList |
string |
links |
< Link > array |
3.24. Variables
Get variables information
| Name | Description | Schema |
|---|---|---|
dataTypeId |
DatatypeId of variable |
integer (int64) |
puId |
Unit Id of product |
integer (int64) |
samplingInterval |
Sampling Interval |
integer (int32) |
userDefined |
User Defined value |
string |
varDesc |
Variable description |
string |
varId |
Variable Id of Test |
integer (int64) |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://pawin2k19-2/uaa/oauth/authorize
Token URL : https://pawin2k19-2/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://pawin2k19-2/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://pawin2k19-2/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://pawin2k19-2/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |