1. Overview
BFF Layer for genealogy-app-service
1.2. Tags
-
activity-controller : Activity Controller
-
application-tab-controller : Application Tab Controller
-
external-config-controller : External Config Controller
-
graph-viewer-controller : Graph Viewer Controller
-
material-lot-viewer-controller : Material Lot Viewer Controller
-
source-details-viewer-controller : Source Details Viewer Controller
-
used-in-viewer-controller : Used In Viewer Controller
-
user-settings-controller : User Settings Controller
2. Resources
2.1. Activity-controller
Activity Controller
2.1.1. Fetches activity records
GET /activity/v1/activities
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
equipments |
Comma separated list of unit ids |
string |
Query |
processOrders |
Comma separated list of process order ids |
string |
Query |
status |
Comma separated list of activity status, can be 1-Not Started, 2-In Progress, 3-Complete, 4-Skipped, 5-Released |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
412 |
Precondition fail |
No Content |
500 |
Internal server error |
No Content |
503 |
Service unavailable |
No Content |
2.2. Application-tab-controller
Application Tab Controller
2.2.1. Get tabs mapped to appId.
GET /apps/{appId}/tabs
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
appId |
appId |
integer (int64) |
|
Query |
enabled |
enabled |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< ApplicationTabResponseResults > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.2. Get tab details mapped to appId
GET /apps/{appId}/tabs/{tabId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
appId |
appId |
integer (int64) |
Path |
tabId |
tabId |
integer (int64) |
Query |
segmentId |
segmentId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.3. External-config-controller
External Config Controller
2.3.1. Get Configurations
GET /v1/configurations
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
actionId |
actionId |
integer (int32) |
|
Query |
actionName |
actionName |
string |
|
Query |
actionTypeId |
actionTypeId |
integer (int32) |
|
Query |
configId |
configId |
integer (int64) |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
segmentId |
segmentId |
integer (int64) |
|
Query |
size |
size |
integer (int32) |
|
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.4. Graph-viewer-controller
Graph Viewer Controller
2.4.1. Get material lot grapsh details
GET /v1/graph
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
materialLotId |
matertial lot id |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
404 |
ERR404 |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal server error |
No Content |
503 |
Service unavailable |
2.5. Material-lot-viewer-controller
Material Lot Viewer Controller
2.5.1. Get material lot genealogy view data
GET /v1/materialLots/genealogy
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
lotIdentifier |
lot identifier (use lot_identifier/event_num for this property |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.5.2. Get material lot genealogy view data by target lot id
GET /v1/materialLots/genealogy/{targetLotId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
targetLotId |
targetLotId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.5.3. Get SourceLots of a target lot
GET /v1/materialLots/genealogy/{targetLotId}/sourceLots
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Path |
targetLotId |
Target lot/event Id |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal server error |
No Content |
503 |
Service Unavailable |
2.6. Source-details-viewer-controller
Source Details Viewer Controller
2.6.1. Get Source Details data
GET /v1/sourceDetails
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
materialLotId |
Matertial Lot of product |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
object |
401 |
Unauthorized |
No Content |
404 |
ERR404 |
No Content |
500 |
Internal server error |
No Content |
2.6.2. getDefectsObject
GET /v1/sourceDetails/getDefectsObject
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Query |
materialLotActualId |
materialLotActual id |
integer (int64) |
|
Query |
page |
integer (int32) |
|
|
Query |
prodEventId |
Production Event Id |
< integer (int64) > array(multi) |
|
Query |
size |
integer (int32) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
object |
401 |
Unauthorized |
No Content |
412 |
Precondition fail |
No Content |
500 |
Internal server error |
No Content |
503 |
Service unavailable |
No Content |
2.7. Used-in-viewer-controller
Used In Viewer Controller
2.7.1. Get material lot used in details
GET /v1/usedin/{materialLotId}
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
|
Path |
materialLotId |
matertial lot id |
integer (int64) |
|
Query |
offset |
integer (int64) |
||
Query |
page |
integer (int32) |
|
|
Query |
pageNumber |
integer (int32) |
||
Query |
pageSize |
integer (int32) |
||
Query |
paged |
boolean |
||
Query |
size |
integer (int32) |
|
|
Query |
sort.sorted |
boolean |
||
Query |
sort.unsorted |
boolean |
||
Query |
unpaged |
boolean |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
successful |
|
401 |
Unauthorized |
No Content |
404 |
ERR404 |
No Content |
422 |
Unprocessable Entity |
|
500 |
Internal server error |
No Content |
503 |
Service unavailable |
2.8. User-settings-controller
User Settings Controller
2.8.1. Create User settings for the logged in user
POST /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
userSettingsRequest |
User Setting Object |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
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.8.2. Get User settings for the logged in User
GET /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.8.3. Update User settings for the logged in user
PUT /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Body |
request |
User Preference Object |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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.8.4. Delete User settings for the logged in user
DELETE /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
204 |
Success |
string |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, User Setting not found |
|
500 |
Internal Server Error |
2.8.5. Get Privilege Sets
GET /v2/settings/apps
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Header |
Site-Id |
Represents the id of the site to connect to |
string |
Query |
appName |
appName |
string |
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. ActivityRecordV2
Name | Description | Schema |
---|---|---|
activityDetailCommentThreadId |
Test comment thread this record is part of |
integer (int64) |
activityId |
Unique identifier of an activity |
integer (int64) |
activityType |
The info of an activity type |
|
asset |
The Asset (Unit) that identifies this location |
|
autoComplete |
Defines an activity is auto complete |
boolean |
commentsThreadId |
Thread Id of the comment to fetch the comments associated to it |
integer (int64) |
completedType |
Whether the activity was completed by user or system |
|
department |
The Department this location belongs to |
|
description |
The description of an activity |
string |
displayTypeId |
Unique identifier for this display type |
integer (int64) |
dueIn |
The duration an activity is due in |
integer (int64) |
duration |
The duartion an activity is completed in |
integer (int64) |
endTime |
The end time of an activity |
string (date-time) |
entryOn |
The time when an activity happen |
string (date-time) |
estimatedStartTime |
estimatedStartTime for activity |
string (date-time) |
eventNumber |
Creates a key an event can be-time Based event and product change event of an activity |
string |
executionStartTime |
The time when an activity actually started executing |
string (date-time) |
extendedInfo |
The mode of the custom form can be payload, embedded and the external opening of an activity to the another browser |
string |
externalLink |
An activity opens to an external link in another browser that is a custom activity |
string |
generalComment |
General comment associated with an activity |
string |
hasAvailableCells |
Checks for the cells availability |
boolean |
hasVariableAliasing |
Whether the activity variable hasVariableAliasing |
boolean |
keyId |
Event id of an activity |
integer (int64) |
keyTime |
Creates a time stamp for an event can be-time Based event and product change event of an activity |
string (date-time) |
line |
The Line this location belongs to |
|
locked |
An activity is locked |
boolean |
lotIdentifier |
An activity lotIdentifer related to |
string |
operationName |
An activity operationName related to |
string |
overdueComment |
The overdue comment of an activity |
string |
overdueCommentRequired |
The overdue comment is required |
boolean |
overdueCommentsThreadId |
Overdue comment thread this record is part of |
integer (int64) |
overrideLockPermission |
Permission to override the lock if an activity is locked by the user |
boolean |
percentComplete |
The percentage by which an activity is completed |
number (double) |
priority |
integer (int64) |
|
processOrder |
An activity process order related to |
|
product |
The product activity is performed on |
|
sheet |
The info of the sheet associalted with an activity |
|
skipComment |
The skip comment of an activity |
string |
skipCommentRequired |
The skip comment is required |
boolean |
skipCommentsThreadId |
Skip comment thread this record is part of |
integer (int64) |
startTime |
The start time of an activity |
string (date-time) |
status |
The info of the status of an activity |
|
tag |
string |
|
targetDuration |
The target duration when an activity actually complete |
number (double) |
testsToComplete |
Unique identifier of this comment record |
integer (int64) |
timeDue |
The time by which an activity is due |
string (date-time) |
title |
The title of an activity |
string |
user |
The user performing on an activity can be a syatem user |
3.2. ActivityResponseV2EntityModel
Name | Description | Schema |
---|---|---|
activityEndTime |
The end time of an activity |
string (date-time) |
activityRecords |
The List of activity records |
< ActivityRecordV2 > array |
activityStartTime |
The start time of an activity |
string (date-time) |
currentPage |
The current page number |
integer (int32) |
links |
< Link > array |
|
overdueCount |
The count of overdue activities |
integer (int32) |
pageCount |
The page count of activities |
integer (int32) |
totalPagingRecords |
The count of toatal pages records |
integer (int32) |
3.3. ActivityUsers
Name | Description | Schema |
---|---|---|
id |
Unique indentifier for the user id |
integer (int64) |
name |
The user name who is performing on an activity |
string |
systemUser |
Defines if user is a system user |
boolean |
3.4. ApplicationTabDetailResponse
Name | Schema |
---|---|
description |
string |
display_name |
string |
id |
integer (int64) |
standard |
boolean |
tab_config_data |
|
tab_config_expressions |
3.5. ApplicationTabResponseResource
Name | Schema |
---|---|
description |
string |
displayName |
string |
enabled |
boolean |
id |
integer (int64) |
links |
|
sequenceOrder |
integer (int32) |
standard |
boolean |
3.6. ApplicationTabResponseResults
Name | Schema |
---|---|
content |
< ApplicationTabResponseResource > array |
links |
|
page |
3.7. BaseAssetInfo
Name | Description | Schema |
---|---|---|
assetId |
The asset Id |
integer (int64) |
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.8. EntityModel«UsedInInfo»
Name | Description | Schema |
---|---|---|
currentQty |
MateriLot currentQty |
number (float) |
id |
MateriLot Id |
integer (int64) |
initialQty |
MateriLot initialQty |
number (double) |
links |
||
lotDesc |
MateriLot lotDesc |
string |
lotId |
MateriLot lotId |
integer (int64) |
prodCode |
MateriLot prodCode |
string |
prodDesc |
MateriLot prodDesc |
string |
prodFamilyDesc |
MateriLot prodFamilyDesc |
string |
prodFamilyId |
MateriLot prodFamilyId |
integer (int64) |
prodId |
MateriLot prodId |
integer (int64) |
status |
MateriLot Status |
string |
unit |
MateriLot unit |
string |
unitId |
MateriLot unitId |
integer (int64) |
unitOfMeasure |
MaterialLot UnitOfMeasure |
string |
unitOfMeasureId |
MaterialLot UnitOfMeasure Id |
integer (int64) |
usedQty |
MateriLot usedQty |
number (double) |
3.10. ExternalConfigResponse
Name | Schema |
---|---|
actionId |
integer (int64) |
actionName |
string |
actionType |
string |
actionTypeId |
integer (int64) |
configId |
integer (int64) |
createdBy |
string |
createdOn |
string |
data |
object |
deleted |
boolean |
id |
integer (int64) |
lastModifiedOn |
string |
updatedBy |
string |
3.11. ExternalConfigResponsePage
Name | Schema |
---|---|
content |
< ExternalConfigResponse > array |
links |
|
page |
3.12. GraphInfo
Name | Description | Schema |
---|---|---|
consumedQuantity |
Consumed Quantity |
number (double) |
engineeringUnit |
Unit of Measure |
string |
location |
Location of Material |
string |
lotIdentifier |
Material LotIdentifier |
string |
materialLotId |
Material Lot Id |
integer (int64) |
productCode |
Product Code |
string |
status |
Status of Lot |
string |
3.13. GraphResponse
Name | Description | Schema |
---|---|---|
materialLotId |
Material Lot Id |
integer (int64) |
sourceLots |
Material Source Lots |
< GraphInfo > array |
targetLots |
Material Target Lots |
< GraphInfo > array |
3.15. IdNameValue
Name | Description | Schema |
---|---|---|
id |
Unique identifier of this id of every pair/used across several services to represent a generic Id |
integer (int64) |
name |
Unique identifier of this name of every pair/used across several services to represent a generic name |
string |
3.16. InputParamterRequest
Name | Schema |
---|---|
custom_property |
boolean |
input_mapping_key |
string |
input_parameter_data |
string |
input_parameter_id |
integer (int64) |
input_parameter_value |
string |
property_definition_data_type_id |
integer (int32) |
property_definition_data_type_name |
string |
property_definition_id |
string |
property_definition_initial_id |
string |
property_definition_initial_value |
string |
property_group_id |
string |
3.17. 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.19. PageMetadata
Name | Schema |
---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.20. PrivilegeSet
Name | Schema |
---|---|
category |
string |
description |
string |
displayName |
string |
icon |
string |
id |
integer (int32) |
scope |
string |
3.21. Product
Name | Description | Schema |
---|---|---|
code |
Product code for activity Product |
string |
id |
Product Id for activity Product |
integer (int64) |
isAppliedProduct |
flag to differentiate between AppliedProduct is current Product |
boolean |
name |
Product name for activity Product |
string |
3.22. TabConfigData
Name | Schema |
---|---|
authentication |
boolean |
enable_seriallot |
boolean |
external_url |
string |
tab_input_parameters |
< InputParamterRequest > array |
3.24. TemplateVariable
Name | Schema |
---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.25. UriTemplate
Name | Schema |
---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.26. UsedInInfo
Name | Description | Schema |
---|---|---|
currentQty |
MateriLot currentQty |
number (float) |
id |
MateriLot Id |
integer (int64) |
initialQty |
MateriLot initialQty |
number (double) |
lotDesc |
MateriLot lotDesc |
string |
lotId |
MateriLot lotId |
integer (int64) |
prodCode |
MateriLot prodCode |
string |
prodDesc |
MateriLot prodDesc |
string |
prodFamilyDesc |
MateriLot prodFamilyDesc |
string |
prodFamilyId |
MateriLot prodFamilyId |
integer (int64) |
prodId |
MateriLot prodId |
integer (int64) |
status |
MateriLot Status |
string |
unit |
MateriLot unit |
string |
unitId |
MateriLot unitId |
integer (int64) |
unitOfMeasure |
MaterialLot UnitOfMeasure |
string |
unitOfMeasureId |
MaterialLot UnitOfMeasure Id |
integer (int64) |
usedQty |
MateriLot usedQty |
number (double) |
3.27. UsedInInfoPage
Name | Schema |
---|---|
content |
< EntityModel«UsedInInfo» > array |
links |
|
page |
3.28. UserSettingRequest
Name | Description | Schema |
---|---|---|
appId |
integer (int32) |
|
data |
The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} } |
object |
viewName |
string |
3.29. UserSettingResponseResource
Name | Schema |
---|---|
appId |
integer (int32) |
data |
object |
defaultSetting |
boolean |
links |
< Link > array |
viewName |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : http://localhost:8080/uaa/oauth/authorize
Token URL : http://localhost:8080/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://localhost:8080/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://localhost:8080/uaa/oauth/authorize
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://localhost:8080/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |