1. Overview
BFF for SPC Application
1.1. License information
License : Copyright (c) 2020 GE. All Rights Reserved. GE Confidential: Restricted Internal Distribution
License URL : https://github.build.ge.com/plantapps/spc-app-service
Terms of service : null
2. Resources
2.1. Data-model-controller
Data Model Controller
2.1.1. get department list
GET /v1/datamodel/department
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< Department > array |
401 |
Unauthorized |
No Content |
2.1.2. get line list
GET /v1/datamodel/line/{deptId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
deptId |
Department id to apply filter |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< Line > array |
401 |
Unauthorized |
No Content |
2.1.3. get variable group list
GET /v1/datamodel/pugroup/{unitId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
unitId |
Unit id to apply filter |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< Group > array |
401 |
Unauthorized |
No Content |
2.1.4. get unit list
GET /v1/datamodel/unit/{lineId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
lineId |
Line id to apply filter |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
< Unit > array |
401 |
Unauthorized |
No Content |
2.2. Variable-data-controller
Variable Data Controller
2.2.1. Get SPC Chart Data by variable id with the help of mes-dataservice-impl
GET /v1/variable/{variableId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
variableId |
Selected variable to report on |
integer (int64) |
|
Query |
direction |
Direction for NoD query from End Time. 0 = Forward; 1 = Backwards (Default) |
integer (int32) |
|
Query |
endTime |
End time of report range if time range filter selected or reference point if NoD selected |
string (date-time) |
|
Query |
numberOfSamplePoints |
Number of data (NoD) points if NoD filter selected, data will be selected for based on NoD from the specified End Time |
integer (int64) |
|
Query |
startTime |
Start time of report range if time range filter selected |
string (date-time) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Gateway timeout or Service Unavailable |
No Content |
3. Definitions
3.2. DataSourceInfo
| Name | Schema |
|---|---|
nodeId |
string |
systemName |
string |
systemType |
string |
3.3. Department
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
lines |
Collection of lines belonging to this department |
|
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.4. Group
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
variables |
Collection of variables belonging to this group |
3.5. Line
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
isRouteEnabled |
Is this line route enabled. A route enabled line is ready to be used by the route service and has been properly configured. |
boolean |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
units |
Collection of Units belonging to this Line |
3.6. LineCollection
| Name | Schema |
|---|---|
collection |
|
content |
< Line > array |
links |
< Link > array |
3.7. Link
| Name | Description | Schema |
|---|---|---|
href |
string |
|
rel |
string |
|
templated |
Example : |
boolean |
3.8. Unit
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
isInventoryUnit |
Is this unit an inventory unit. A inventory unit is a storage unit. |
boolean |
isVirtual |
Is this unit a virtual unit. A virtual unit is a tracking unit. It doesn’t have physical assets associated with it. |
boolean |
lineId |
The line this unit belongs to |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
unitRank |
This unit’s rank |
integer (int32) |
units |
Collection of Groups belonging to this Unit |
3.9. UnitCollection
| Name | Schema |
|---|---|
collection |
|
content |
< Unit > array |
links |
< Link > array |
3.10. Variable
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
inputTag |
The Input Tag data source for this variable |
|
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.11. VariableCollection
| Name | Schema |
|---|---|
collection |
|
content |
< Variable > array |
links |
< Link > array |
3.12. WsSPCCriteriaSummary
| Name | Schema |
|---|---|
hyperlink |
string |
id |
integer (int64) |
name |
string |
value |
string |
valueParameter |
string |
3.13. WsSPCProductRunning
| Name | Description | Schema |
|---|---|---|
isBasisProduct |
Example : |
boolean |
prodCode |
Product code |
string |
rawValue |
number (double) |
|
subgroupId |
Property is used for internal calculation inside store proc |
integer (int64) |
timestamp |
Result_On value of tests table |
string (date-time) |
value |
Variable data value(Result) from tests table |
string |
xid |
Identity column |
integer (int64) |
3.14. WsSPCStatistics
| Name | Description | Schema |
|---|---|---|
promptId |
Identity column |
integer (int64) |
promptName |
Hold information like: CriteriaSummary, ControlChart, Average, Maximum, ProcessMaximum, ProcessMinimum, Zlsl |
string |
promptValue |
string |
|
promptValueParameter |
string |
|
promptValueParameter2 |
string |
|
promptValueParameter3 |
string |
|
promptValueParameter4 |
string |
3.15. WsSPCStatistics2
| Name | Description | Schema |
|---|---|---|
average |
Average of subgroups |
number (float) |
cp |
Cp is Process Capability. The SPC Cp measurement shows how well the Six Sigma range fits into the specification range |
number (float) |
cpk |
Cpk stands for Process Capability Index. The SPC Cpk measurement shows the relationship of the Six Sigma spread to the specification limits. |
number (float) |
cpm |
Six Sigma Material. Cpm is a Process Capability Index |
number (float) |
cr |
Capability Ratio |
number (float) |
estimatedSigma |
number (float) |
|
lcl |
Lower Control Specification Limit |
number (float) |
lsl |
Lower Reject Specification Limit |
number (float) |
maximum |
Maximum subgroup value |
number (float) |
mininmum |
Minimum subgroup value |
number (float) |
numberOfPoints |
Number to sample points for calculation |
number (float) |
pp |
PP (also written as PK) stands for Process Performance |
number (float) |
ppk |
PPK means Process Performance Index |
number (float) |
processMaximum |
Maximum of individuals |
number (float) |
processMean |
Average of individuals |
number (float) |
processMinimum |
Minimum of individuals |
number (float) |
prodDesc |
Product Description of a Running Product |
string |
prodId |
Product Id of a Running Product |
integer (int64) |
runId |
Identity column |
integer (int64) |
sigma |
Standard Deviation of individuals |
number (float) |
target |
Target Specification |
number (float) |
ucl |
Upper Control Specification Limit |
number (float) |
usl |
Upper Reject Specification Limit |
number (float) |
zlsl |
Number of sigmas, the LSL is away from the mean |
number (float) |
zt |
number (float) |
|
zusl |
Number of sigmas, the USL is away from the mean |
number (float) |
3.16. WsSPCVariableChartInfo
| Name | Description | Schema |
|---|---|---|
alarm |
integer (int32) |
|
dataPointText |
Alarm related description |
string |
mr |
Moving Range value of SPC variable |
number (float) |
mrscl |
Calculated Control (Target Control) Specification Limit for SPC calculation type |
number (float) |
mrslcl |
Calculated Lower Control Specification Limit for SPC calculation type |
number (float) |
mrslsl |
Lower Reject Specification Limit for SPC calculation type |
number (float) |
mrslul |
Lower User Specification Limit for SPC calculation type |
number (float) |
mrslwl |
Lower Warning Specification Limit for SPC calculation type |
number (float) |
mrsucl |
Calculated Upper Control Specification Limit for SPC calculation type |
number (float) |
mrsusl |
Upper Reject Specification Limit for SPC calculation type |
number (float) |
mrsuul |
Upper User Specification Limit for SPC calculation type |
number (float) |
mrsuwl |
Upper Warning Specification Limit for SPC calculation type |
number (float) |
pchart |
number (float) |
|
r |
Range value of SPC variable |
number (float) |
result |
Variable data value(Result) from tests table |
string |
s |
Standard Deviation of SPC variable |
number (float) |
subgroupId |
Identity column |
integer (int64) |
timestamp |
Result_On value from tests table |
string (date-time) |
uchart |
number (float) |
|
xcl |
Calculated Control Specification Limit |
number (float) |
xlcl |
Calculated Lower Control Specification Limit |
number (float) |
xlsl |
Calculated Lower Reject Specification Limit(LSL) based on GoodValueMin |
number (float) |
xlul |
Lower User Specification Limit |
number (float) |
xlwl |
Lower Warning Specification Limit |
number (float) |
xucl |
Calculated Uppder Control Specification Limit |
number (float) |
xusl |
Calculated Upper Reject Specification Limit(USL) based on GoodValueMax |
number (float) |
xuul |
Upper User Specification Limit |
number (float) |
xuwl |
Upper Warning Specification Limit |
number (float) |
3.17. WsSPCVariableData
| Name | Schema |
|---|---|
calculationType |
string |
criteriaSummary |
< WsSPCCriteriaSummary > array |
productRunning |
< WsSPCProductRunning > array |
statistics |
< WsSPCStatistics > array |
statistics2 |
< WsSPCStatistics2 > array |
variableChartInfo |
< WsSPCVariableChartInfo > array |
variableId |
integer (int64) |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://hostname/uaa/oauth/authorize
Token URL : https://hostname/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://hostname/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://hostname/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://hostname/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |