1. Overview
Documentation for receiving-inspection-app-service API v1.0
1.3. Tags
-
material-lot-controller : Material Lot Controller
-
product-controller : Product Controller
-
property-definition-controller : Property Definition 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
-
variable-controller : Variable Controller
2. Resources
2.1. Material-lot-controller
Material Lot Controller
2.1.1. Create MaterialLot
POST /v1.0/materialLots/materialLot
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.1.2. Validating the MaterialLot Names sent for a given Unit Id
POST /v1.0/materialLots/validate
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.1.3. Used for updating the disposition info for a material lot Id
PUT /v1.0/materialLots/{materialLotId}/disposition
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotId |
materialLotId |
integer (int64) |
Body |
dispositionInfo |
dispositionInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
201 |
CREATED |
object |
400 |
Bad data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.1.4. Get list of materialLot properties
GET /v1.0/materialLots/{materialLotId}/properties
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLotPropertyDefinitionInfo > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.2. Product-controller
Product Controller
2.2.1. Get list of material properties
GET /v1.0/product/{productId}/properties
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.3. Property-definition-controller
Property Definition Controller
2.3.1. Get All Additional properties
GET /v1.0/additionalProperties
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PropertyDefinitionInfo > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4. Receiver-material-lots-controller
Receiver Material Lots Controller
2.4.1. Update multiple MaterialLot records
PUT /v1.0/receiverMaterialLots/materialLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
materialLotUpdateInfo |
materialLotUpdateInfo |
< MaterialLotUpdate > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
string |
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.2. Get All MaterialLots
GET /v1.0/receiverMaterialLots/receivers
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 |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.3. 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 |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.4. Get All Sample Tests
GET /v1.0/receiverMaterialLots/tests
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< SampleTestMaterialLots > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.5. Get All MaterialLots By receiverId
GET /v1.0/receiverMaterialLots/{receiverId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ReceiverMaterialLotsDto > array |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.6. Update MaterialLot records of receivernumber
POST /v1.0/receiverMaterialLots/{receiverId}/assignSerialNumbers
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
receiverId |
receiverId |
integer (int64) |
Body |
receiverMaterialLotsInfo |
receiverMaterialLotsInfo |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511) |
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.4.7. Update Receiver status
POST /v1.0/receiverMaterialLots/{receiverId}/complete
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511) |
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.5. Sample-material-lot-controller
Sample Material Lot Controller
2.5.1. Create sample
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.5.2. Update Sample
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.5.3. 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.6. Test-material-lot-controller
Test Material Lot Controller
2.6.1. 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.7. Units-controller
Units Controller
2.7.1. Retrieves all the statuses of a given Unit ID
GET /v1.0/units/{unitId}/prodExecutionTransitions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
unitId |
unitId |
integer (int64) |
Query |
fromStatusIds |
fromStatusIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad data |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.8. Variable-controller
Variable Controller
2.8.1. Get variable specification limit for a particular time
GET /v1.0/variable/variablespecification
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
startTime |
time at which you are looking for |
string |
Query |
variableIds |
List of variables separated by comma(,) |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
3. Definitions
3.1. DefectInfoResponse
| Name | Schema |
|---|---|
affectedObjectId |
string |
affectedObjectType |
string |
affectedQuantity |
number (double) |
affectedQuantityUnitOfMeasure |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
defectCauseTreeId |
string |
defectContextType |
string |
defectId |
integer (int64) |
defectReasonLevel1Id |
string |
defectReasonLevel1Name |
string |
defectReasonLevel2Id |
string |
defectReasonLevel2Name |
string |
defectReasonLevel3Id |
string |
defectReasonLevel3Name |
string |
defectReasonLevel4Id |
string |
defectReasonLevel4Name |
string |
defectTypeId |
integer (int64) |
defectTypeName |
string |
description |
string |
dispositionActionTreeId |
string |
dispositionActions |
< DispositionActionInfo > array |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
locationId |
string |
locationType |
string |
ncLastModifiedBy |
string |
ncLastModifiedOn |
string (date-time) |
nonConformanceType |
string |
nonconformanceDescription |
string |
nonconformanceId |
integer (int64) |
nonconformanceName |
string |
nonconformanceTypeId |
integer (int64) |
parentId |
integer (int64) |
propertyValues |
< DefectPropertyValueInfo > array |
reportedBy |
string |
status |
string |
summary |
string |
version |
integer (int32) |
3.2. DefectPropertyValueInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
value |
string |
version |
integer (int32) |
3.3. DispositionActionInfo
| Name | Schema |
|---|---|
actionNote |
string |
commentId |
string |
createdBy |
string |
createdOn |
string (date-time) |
daReasonLevel1Id |
string |
daReasonLevel2Id |
string |
daReasonLevel3Id |
string |
daReasonLevel4Id |
string |
dispositionActionId |
integer (int64) |
dispositionPlan |
|
dispositionPlanId |
integer (int64) |
dispositionTypeId |
integer (int64) |
dispositionTypeName |
string |
dispositionTypeNameGlobal |
string |
elapsedTime |
integer (int32) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
lastModifiedOperation |
string |
name |
string |
parentId |
integer (int64) |
properties |
< PropertyValueInfo > array |
quantity |
number (double) |
status |
string |
version |
integer (int32) |
3.4. DispositionInfo
Disposition Info for updating in PA for a material lot
| Name | Description | Schema |
|---|---|---|
propertyValues |
Property values for a given material lot |
< MaterialProperties > array |
statusId |
Disposition status for a given material lot |
integer (int64) |
unitId |
Unit Id for which the statuses to be retrieved |
integer (int64) |
3.5. DispositionPlanInfo
| Name | Description | Schema |
|---|---|---|
createdBy |
string |
|
createdOn |
string (date-time) |
|
dispositionPlanId |
integer (int64) |
|
id |
integer (int64) |
|
lastModifiedBy |
string |
|
lastModifiedOn |
string (date-time) |
|
name |
string |
|
requiresReview |
Example : |
boolean |
reviewed |
Example : |
boolean |
reviewedBy |
string |
|
reviewedOn |
string (date-time) |
|
source |
string |
|
status |
string |
|
version |
integer (int32) |
3.8. HttpErrorResponseNew
| Name | Schema |
|---|---|
error |
|
path |
string |
timestampVal |
string |
3.9. Link
| Name | Description | Schema |
|---|---|---|
href |
string |
|
rel |
string |
|
templated |
Example : |
boolean |
3.10. MaterialLot
| Name | Schema |
|---|---|
initialQuantity |
number (double) |
lotIdentifier |
string |
productId |
integer (int64) |
properties |
< MaterialProperties > array |
status |
string |
3.11. MaterialLotProperties
| Name | Schema |
|---|---|
propertyDataTyeId |
integer (int64) |
propertyDataType |
string |
propertyDefinitionId |
string |
propertyName |
string |
propertyValue |
string |
3.12. MaterialLotPropertyDefinitionInfo
| Name | Description | Schema |
|---|---|---|
dataType |
The datatype of the property |
string |
propertyDefinitionId |
The id of the property definition |
string |
propertyDefinitionName |
The name of the property definition |
string |
propertyValue |
The value of the property |
string |
3.13. MaterialLotPropertyResults
| Name | Schema |
|---|---|
content |
< MaterialLotPropertyDefinitionInfo > array |
links |
< Link > array |
page |
3.14. MaterialLotPropertyValues
| Name | Schema |
|---|---|
propertyDefinitionId |
string |
propertyValue |
string |
3.15. MaterialLotUpdate
MaterialLotUpdate
| Name | Description | Schema |
|---|---|---|
lotIdentifier |
string |
|
lotQuantity |
number (double) |
|
materialLotId |
integer (int64) |
|
productId |
integer (int64) |
|
propertyValues |
< MaterialLotPropertyValues > array |
|
statusId |
integer (int64) |
|
unitId |
materialot unit Id |
integer (int64) |
3.16. MaterialLots
| Name | Schema |
|---|---|
commentId |
integer (int64) |
isSerialized |
boolean |
lotIdentifier |
string |
materialLotId |
integer (int64) |
materialLotStatus |
string |
materialLotStatusId |
integer (int64) |
materialLotsEntryOn |
string |
productCode |
string |
productDesc |
string |
productId |
integer (int64) |
quantity |
integer (int64) |
unitId |
integer (int64) |
unitName |
string |
3.17. MaterialLotsDto
| Name | Schema |
|---|---|
commentId |
integer (int64) |
defectInfoResponse |
|
isSerialized |
boolean |
lotIdentifier |
string |
materialLotId |
integer (int64) |
materialLotStatus |
string |
materialLotStatusId |
integer (int64) |
materialLotsEntryOn |
string |
productCode |
string |
productDesc |
string |
productId |
integer (int64) |
propertyValues |
< MaterialLotProperties > array |
quantity |
integer (int64) |
unitId |
integer (int64) |
unitName |
string |
3.18. MaterialProperties
Properties of a material.
| Name | Description | Schema |
|---|---|---|
propertyDefinitionId |
string |
|
propertyName |
Name of the property |
string |
propertyValue |
Value of the property |
string |
3.19. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.20. PropertyDefinitionInfo
| Name | Schema |
|---|---|
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyDefinitionId |
string |
propertyName |
string |
3.21. PropertyValueInfo
| Name | Schema |
|---|---|
createdBy |
string |
createdOn |
string (date-time) |
dispositionActionHistoryId |
integer (int64) |
id |
integer (int64) |
lastModifiedBy |
string |
lastModifiedOn |
string (date-time) |
originId |
integer (int64) |
propertyDefinitionId |
string |
propertyValueId |
integer (int64) |
value |
string |
version |
integer (int32) |
3.22. ReceiverInfo
| Name | Schema |
|---|---|
productCode |
string |
productId |
integer (int64) |
receiverNumber |
string |
receiverStatus |
string |
sourceEventId |
integer (int64) |
3.23. ReceiverMaterialLots
| Name | Schema |
|---|---|
materialLots |
< MaterialLots > array |
receiverNumber |
string |
receiverStatus |
string |
receiverStatusId |
integer (int64) |
receiverUnitId |
integer (int64) |
sourceEventId |
integer (int64) |
timeStampValue |
string |
3.24. ReceiverMaterialLotsDto
| Name | Schema |
|---|---|
materialLots |
< MaterialLotsDto > array |
receiverNumber |
string |
receiverStatus |
string |
receiverStatusId |
integer (int64) |
receiverUnitId |
integer (int64) |
sampleQuantity |
integer (int64) |
sourceEventId |
integer (int64) |
timeStampValue |
string |
3.25. ReceiverMaterialLotsInfo
| Name | Schema |
|---|---|
materialLots |
< MaterialLotUpdate > array |
receiverStatusId |
integer (int64) |
receiverUnitId |
integer (int64) |
3.26. SampleMaterialLotId
Sample material lot Id.
| Name | Description | Schema |
|---|---|---|
materialLotId |
The Id of Material Lot |
integer (int64) |
3.27. 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.28. SampleMaterialLotUpdateInfo
Sample update data tranfer object
| Name | Description | Schema |
|---|---|---|
sampleName |
Name of the sample |
string |
3.29. SampleTestMaterialLotResult
| 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 |
tests |
< TestMaterialLotResult > array |
3.30. SampleTestMaterialLots
| Name | Schema |
|---|---|
commentId |
integer (int64) |
materialLot |
string |
materialLotId |
integer (int64) |
materialLotStatus |
string |
productCode |
string |
productDescription |
string |
quantity |
integer (int64) |
samples |
< Samples > array |
3.31. Samples
| Name | Schema |
|---|---|
autoGeneratedSample |
boolean |
sample |
string |
sampleId |
integer (int64) |
tests |
< Tests > array |
3.32. StatusCombination
| Name | Schema |
|---|---|
fromStatusDescription |
string |
fromStatusId |
integer (int32) |
toStatusDescription |
string |
toStatusId |
integer (int32) |
3.33. TestMaterialLotInfoRequest
| Name | Schema |
|---|---|
eventId |
integer (int64) |
receiverId |
integer (int64) |
testValue |
string |
variableId |
integer (int32) |
3.34. 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.35. TestValueSpecifications
| Name | Schema |
|---|---|
dataTypeId |
integer (int64) |
eSignatureLevel |
integer (int64) |
id |
integer (int64) |
isInclusiveSpecCalc |
boolean |
lowerControlLimit |
object |
lowerEntryLimit |
object |
lowerRejectLimit |
object |
lowerUserLimit |
object |
lowerWarningLimit |
object |
target |
object |
targetControl |
object |
targetFreq |
integer (int32) |
upperControlLimit |
object |
upperEntryLimit |
object |
upperRejectLimit |
object |
upperUserLimit |
object |
upperWarningLimit |
object |
variableId |
integer (int64) |
3.36. Tests
| Name | Schema |
|---|---|
commentId |
integer (int64) |
dataType |
string |
dataTypeId |
integer (int64) |
requiresInspection |
boolean |
specDesc |
string |
testId |
integer (int64) |
userDefined1 |
string |
value |
string |
varPrecision |
integer (int32) |
variable |
string |
variableId |
integer (int64) |
3.37. TransactionStatus
| Name | Schema |
|---|---|
links |
< Link > array |
plannedUnitId |
integer (int64) |
prodExecutionTransitions |
< StatusCombination > array |
3.38. ValidationRequestInfo
| Name | Description | Schema |
|---|---|---|
materialLotNames |
< string > array |
|
newLotStatusId |
Status ID of the material lot to be updated |
integer (int32) |
plannedUnitId |
integer (int64) |
|
productId |
integer (int64) |
|
transNum |
TransNum value to determine the type of validation to perform |
enum (1, 2) |
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. |