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

1.2. URI scheme

Host : localhost:36483
BasePath : /

1.3. Tags

  • data-model-controller : Data Model Controller

  • variable-data-controller : Variable Data Controller

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

Produces
  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. get line list

GET /v1/datamodel/line/{deptId}
Parameters
Type Name Description Schema

Path

deptId
required

Department id to apply filter

integer (int64)

Responses
HTTP Code Description Schema

200

Success

< Line > array

401

Unauthorized

No Content

Produces
  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. get variable group list

GET /v1/datamodel/pugroup/{unitId}
Parameters
Type Name Description Schema

Path

unitId
required

Unit id to apply filter

integer (int64)

Responses
HTTP Code Description Schema

200

Success

< Group > array

401

Unauthorized

No Content

Produces
  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. get unit list

GET /v1/datamodel/unit/{lineId}
Parameters
Type Name Description Schema

Path

lineId
required

Line id to apply filter

integer (int64)

Responses
HTTP Code Description Schema

200

Success

< Unit > array

401

Unauthorized

No Content

Produces
  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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
required

Selected variable to report on

integer (int64)

Query

direction
optional

Direction for NoD query from End Time. 0 = Forward; 1 = Backwards (Default)

integer (int32)

1

Query

endTime
optional

End time of report range if time range filter selected or reference point if NoD selected

string (date-time)

Query

numberOfSamplePoints
optional

Number of data (NoD) points if NoD filter selected, data will be selected for based on NoD from the specified End Time

integer (int64)

0

Query

startTime
optional

Start time of report range if time range filter selected

string (date-time)

Responses
HTTP Code Description Schema

200

Success

WsSPCVariableData

400

Bad request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Gateway timeout or Service Unavailable

No Content

Produces
  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.2. DataSourceInfo

Name Schema

nodeId
optional

string

systemName
optional

string

systemType
optional

string

3.3. Department

Name Description Schema

assetId
optional

The asset ID

integer (int64)

lines
optional

Collection of lines belonging to this department

LineCollection

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

3.4. Group

Name Description Schema

assetId
optional

The asset ID

integer (int64)

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

variables
optional

Collection of variables belonging to this group

VariableCollection

3.5. Line

Name Description Schema

assetId
optional

The asset ID

integer (int64)

isRouteEnabled
optional

Is this line route enabled. A route enabled line is ready to be used by the route service and has been properly configured.
Example : false

boolean

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

units
optional

Collection of Units belonging to this Line

UnitCollection

3.6. LineCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Line > array

links
optional

< Link > array

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.8. Unit

Name Description Schema

assetId
optional

The asset ID

integer (int64)

isInventoryUnit
optional

Is this unit an inventory unit. A inventory unit is a storage unit.
Example : false

boolean

isVirtual
optional

Is this unit a virtual unit. A virtual unit is a tracking unit. It doesn’t have physical assets associated with it.
Example : false

boolean

lineId
optional

The line this unit belongs to

integer (int64)

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

unitRank
optional

This unit’s rank

integer (int32)

units
optional

Collection of Groups belonging to this Unit

UnitCollection

3.9. UnitCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Unit > array

links
optional

< Link > array

3.10. Variable

Name Description Schema

assetId
optional

The asset ID

integer (int64)

inputTag
optional

The Input Tag data source for this variable

DataSourceInfo

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

3.11. VariableCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Variable > array

links
optional

< Link > array

3.12. WsSPCCriteriaSummary

Name Schema

hyperlink
optional

string

id
optional

integer (int64)

name
optional

string

value
optional

string

valueParameter
optional

string

3.13. WsSPCProductRunning

Name Description Schema

isBasisProduct
optional

Example : false

boolean

prodCode
optional

Product code

string

rawValue
optional

number (double)

subgroupId
optional

Property is used for internal calculation inside store proc

integer (int64)

timestamp
optional

Result_On value of tests table

string (date-time)

value
optional

Variable data value(Result) from tests table

string

xid
optional

Identity column

integer (int64)

3.14. WsSPCStatistics

Name Description Schema

promptId
optional

Identity column

integer (int64)

promptName
optional

Hold information like: CriteriaSummary, ControlChart, Average, Maximum, ProcessMaximum, ProcessMinimum, Zlsl

string

promptValue
optional

string

promptValueParameter
optional

string

promptValueParameter2
optional

string

promptValueParameter3
optional

string

promptValueParameter4
optional

string

3.15. WsSPCStatistics2

Name Description Schema

average
optional

Average of subgroups

number (float)

cp
optional

Cp is Process Capability. The SPC Cp measurement shows how well the Six Sigma range fits into the specification range

number (float)

cpk
optional

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
optional

Six Sigma Material. Cpm is a Process Capability Index

number (float)

cr
optional

Capability Ratio

number (float)

estimatedSigma
optional

number (float)

lcl
optional

Lower Control Specification Limit

number (float)

lsl
optional

Lower Reject Specification Limit

number (float)

maximum
optional

Maximum subgroup value

number (float)

mininmum
optional

Minimum subgroup value

number (float)

numberOfPoints
optional

Number to sample points for calculation

number (float)

pp
optional

PP (also written as PK) stands for Process Performance

number (float)

ppk
optional

PPK means Process Performance Index

number (float)

processMaximum
optional

Maximum of individuals

number (float)

processMean
optional

Average of individuals

number (float)

processMinimum
optional

Minimum of individuals

number (float)

prodDesc
optional

Product Description of a Running Product

string

prodId
optional

Product Id of a Running Product

integer (int64)

runId
optional

Identity column

integer (int64)

sigma
optional

Standard Deviation of individuals

number (float)

target
optional

Target Specification

number (float)

ucl
optional

Upper Control Specification Limit

number (float)

usl
optional

Upper Reject Specification Limit

number (float)

zlsl
optional

Number of sigmas, the LSL is away from the mean

number (float)

zt
optional

number (float)

zusl
optional

Number of sigmas, the USL is away from the mean

number (float)

3.16. WsSPCVariableChartInfo

Name Description Schema

alarm
optional

integer (int32)

dataPointText
optional

Alarm related description

string

mr
optional

Moving Range value of SPC variable

number (float)

mrscl
optional

Calculated Control (Target Control) Specification Limit for SPC calculation type

number (float)

mrslcl
optional

Calculated Lower Control Specification Limit for SPC calculation type

number (float)

mrslsl
optional

Lower Reject Specification Limit for SPC calculation type

number (float)

mrslul
optional

Lower User Specification Limit for SPC calculation type

number (float)

mrslwl
optional

Lower Warning Specification Limit for SPC calculation type

number (float)

mrsucl
optional

Calculated Upper Control Specification Limit for SPC calculation type

number (float)

mrsusl
optional

Upper Reject Specification Limit for SPC calculation type

number (float)

mrsuul
optional

Upper User Specification Limit for SPC calculation type

number (float)

mrsuwl
optional

Upper Warning Specification Limit for SPC calculation type

number (float)

pchart
optional

number (float)

r
optional

Range value of SPC variable

number (float)

result
optional

Variable data value(Result) from tests table

string

s
optional

Standard Deviation of SPC variable

number (float)

subgroupId
optional

Identity column

integer (int64)

timestamp
optional

Result_On value from tests table

string (date-time)

uchart
optional

number (float)

xcl
optional

Calculated Control Specification Limit

number (float)

xlcl
optional

Calculated Lower Control Specification Limit

number (float)

xlsl
optional

Calculated Lower Reject Specification Limit(LSL) based on GoodValueMin

number (float)

xlul
optional

Lower User Specification Limit

number (float)

xlwl
optional

Lower Warning Specification Limit

number (float)

xucl
optional

Calculated Uppder Control Specification Limit

number (float)

xusl
optional

Calculated Upper Reject Specification Limit(USL) based on GoodValueMax

number (float)

xuul
optional

Upper User Specification Limit

number (float)

xuwl
optional

Upper Warning Specification Limit

number (float)

3.17. WsSPCVariableData

Name Schema

calculationType
optional

string

criteriaSummary
optional

< WsSPCCriteriaSummary > array

productRunning
optional

< WsSPCProductRunning > array

statistics
optional

< WsSPCStatistics > array

statistics2
optional

< WsSPCStatistics2 > array

variableChartInfo
optional

< WsSPCVariableChartInfo > array

variableId
optional

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.