2. Resources
2.1. Bom-family-controller
Bom Family Controller
2.1.1. Get BOM Families
GET /bom/bomFamilies
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.1.2. Get BOM Masters
GET /bom/bomMasters
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.1.3. Get BOM Master by id
GET /bom/bomMasters/{id}
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.2. Bom-formulation-controller
Bom Formulation Controller
2.2.1. Create BOM Formulation
POST /bomFormulations
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service unavailable |
2.2.2. Get All BOM formulations
GET /bomFormulations
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
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) |
|
2.2.3. Update BOM Formulation
PUT /bomFormulations
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
bomFormulationUpdateRequest |
bomFormulationUpdateRequest |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service unavailable |
2.2.4. Get BOM formulation by Id
GET /bomFormulations/{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 |
2.2.5. Create BOM Formulation Items
POST /bomFormulations/{formulationId}/items
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
formulationId |
formulationId |
integer (int64) |
Body |
bomFormulationItems |
bomFormulationItems |
< BomFormulationItemForCreate > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
object |
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.6. Get BOM items by BOM formulationId
GET /bomFormulations/{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 |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
503 |
Service Unavailable |
2.2.7. Update BOM Formulation Items
PUT /bomFormulations/{formulationId}/items
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
formulationId |
formulationId |
integer (int64) |
Body |
bomFormulationItemsForUpdate |
bomFormulationItemsForUpdate |
< BomFormulationItemForUpdate > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
object |
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.8. Delete BOM Formulation Items
DELETE /bomFormulations/{formulationId}/items
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
formulationId |
formulationId |
integer (int64) |
Query |
formulationItemIds |
formulationItemIds |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
object |
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.9. Create/Update/Delete BOM Formulation Items
PUT /bomFormulations/{formulationId}/items/save
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
formulationId |
formulationId |
integer (int64) |
Body |
bomFormulationItemsForSave |
bomFormulationItemsForSave |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Success |
object |
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.3. Product-controller
Product Controller
2.3.1. Get all engineering units
GET /engineeringUnits
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.3.2. Get Products
GET /products
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.4. User-settings-controller
User Settings Controller
2.4.1. Create User settings for the logged in user
POST /v2/settings
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
object |
204 |
No Content, Error retrieving created user settings |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
App ID not found in privilege set |
|
409 |
Conflict, User Setting already exists. Use a PUT to update |
|
500 |
Internal Server Error |
2.4.2. Get User settings for the logged in User
GET /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.4.3. Update User settings for the logged in user
PUT /v2/settings
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, There is no saved User settings for the logged in user |
|
500 |
Internal Server Error |
2.4.4. Delete User settings for the logged in user
DELETE /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
204 |
Success |
object |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, User Setting not found |
|
500 |
Internal Server Error |
2.4.5. Get Privilege Sets
GET /v2/settings/apps
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< PrivilegeSet > array |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
3. Definitions
3.1. 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.2. 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.3. BomFormulationInfo
Name | Description | Schema |
---|---|---|
bomFamilyId |
integer (int32) |
|
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) |
products |
< ProductResponse > array |
|
quantityPrecision |
Quantity Precision |
integer (int32) |
standardQuantity |
standard quantity |
number (double) |
uom |
Eng unit Id |
integer (int64) |
uomCode |
string |
3.4. 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.5. BomFormulationInfoResults
Name | Schema |
---|---|
content |
< BomFormulationInfoResult > array |
links |
< Link > array |
page |
3.6. 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.7. 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.8. BomFormulationItemsForSave
Name | Schema |
---|---|
formulationItemsForCreate |
< BomFormulationItemForCreate > array |
formulationItemsForDelete |
< integer (int64) > array |
formulationItemsForUpdate |
< BomFormulationItemForUpdate > array |
3.11. Link
Name | Description | Schema |
---|---|---|
href |
string |
|
rel |
string |
|
templated |
Example : |
boolean |
3.12. PageMetadata
Name | Schema |
---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.13. PrivilegeSet
Name | Schema |
---|---|
category |
string |
description |
string |
displayName |
string |
icon |
string |
id |
integer (int32) |
scope |
string |
3.14. ProductResponse
Name | Schema |
---|---|
productDescription |
string |
productId |
integer (int64) |
productName |
string |
3.15. UserSettingRequest
Name | Description | Schema |
---|---|---|
appId |
integer (int32) |
|
data |
The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} } |
object |
viewName |
string |
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. |