1. Overview
Microservice containing the business logic for retrival of information relevant to manufacturing execution
1.2. Tags
-
batch-data-controller : Batch Data Controller
-
historian-data-controller : Historian Data Controller
-
historians-controller : Historians Controller
-
historians-tag-data-controller : Historians Tag Data Controller
-
kpi-data-controller : KPI Data Controller
-
process-order-data-controller : Process Order Data Controller
-
product-data-controller : Product Data Controller
-
site-name-controller : Site Name Controller
-
tag-data-controller : Tag Data Controller
-
variable-data-controller : Variable Data Controller
2. Resources
2.1. Batch-data-controller
Batch Data Controller
2.1.1. To get site name
GET /mesdataservice/v1/batchdata
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
asset |
asset |
string |
|
Query |
bom |
bom |
integer (int64) |
|
Query |
departmentId |
departmentId |
integer (int64) |
|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isGoldenBatch |
isGoldenBatch |
boolean |
|
Query |
lineId |
lineId |
integer (int64) |
|
Query |
name |
name |
string |
|
Query |
pageNumber |
pageNumber |
integer (int64) |
|
Query |
pageSize |
pageSize |
integer (int64) |
|
Query |
product |
product |
string |
|
Query |
quantity |
quantity |
string |
|
Query |
sortCol |
sortCol |
string |
|
Query |
sortOrder |
sortOrder |
string |
|
Query |
startTime |
startTime |
string (date-time) |
|
Query |
status |
status |
string |
|
Query |
unitId |
unitId |
integer (int64) |
2.1.2. To get site name
GET /mesdataservice/v1/batchdata/adjacentbatchdata
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
Query |
eventId |
eventId |
integer (int64) |
Query |
startTime |
startTime |
string (date-time) |
2.1.3. To get site name
GET /mesdataservice/v1/batchdata/batchproducttraverse
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
eventId |
eventId |
integer (int64) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
nextOrPrevious |
nextOrPrevious |
string |
|
Query |
startTime |
startTime |
string (date-time) |
2.1.4. To get site name
GET /mesdataservice/v1/batchdata/batchtraverse
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
eventId |
eventId |
integer (int64) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
nextOrPrevious |
nextOrPrevious |
string |
|
Query |
startTime |
startTime |
string (date-time) |
2.2. Historian-data-controller
Historian Data Controller
2.2.1. Gets the list of configured historian server details
GET /mesdataservice/v1/historians
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< HistoriansInfo > array |
2.3. Historians-controller
Historians Controller
2.3.1. Create historian Alias
POST /mesdataservice/v1/plantapp/historian
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
201 |
Created |
|
400 |
Bad request |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Gateway timeout or Service Unavailable |
No Content |
2.3.2. Get historians in pageable format
GET /mesdataservice/v1/plantapp/historian
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
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 |
2.3.3. Get historian based on Id
GET /mesdataservice/v1/plantapp/historian/{id}
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 |
2.3.4. Update historian
PUT /mesdataservice/v1/plantapp/historian/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Historian id |
integer (int32) |
Body |
historianInfo |
Historian details |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad request |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Gateway timeout or Service Unavailable |
No Content |
2.3.5. Delete Specific Historian
DELETE /mesdataservice/v1/plantapp/historian/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
202 |
Accepted |
|
400 |
Bad request |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Gateway timeout or Service Unavailable |
No Content |
2.3.6. Get historian options
GET /mesdataservice/v1/plantapp/historian/{id}/options
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad request |
No Content |
401 |
Unauthorized |
No Content |
422 |
Unprocessable Entity |
No Content |
500 |
Internal Server Error |
No Content |
503 |
Gateway timeout or Service Unavailable |
No Content |
2.3.7. Get historians with os list and historian type list
GET /mesdataservice/v1/plantapp/historians
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 |
2.3.8. Get historian type
GET /mesdataservice/v1/plantapp/historiantypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
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 |
2.3.9. Get operating system list
GET /mesdataservice/v1/plantapp/operatingsystems
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Page number to return 0 to N. |
integer (int32) |
|
Query |
size |
Number of resources to return per page. |
integer (int32) |
|
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 |
2.4. Historians-tag-data-controller
Historians Tag Data Controller
2.4.1. Gets Data points for the tag names specified from particular historian server based on the request parameters
GET /v1/historianTagsDataPoints
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
calculationMode |
This parameter is only applied if the Sampling Mode is set to Calculated. It represents the type of calculation to use on the archive data. |
enum (Average, StandardDeviation, Total, Minimum, Maximum, Count, RawAverage, RawStandardDeviation, RawTotal, MinimumTime, MaximumTime, TimeGood, StateCount, StateTime, OPCAnd, OPCOr, FirstRawValue, FirstRawTime, LastRawValue, LastRawTime, TagStats) |
Query |
dataPointType |
Data point type end point which needs to be queried from Historian Service |
enum (raw, interpolated, currentvalue, calculated, sampled) |
Query |
direction |
Specifies the direction (Forward (0) or Backward (1) from the starting time) of data sampling from the archive. |
integer (int32) |
Query |
endTime |
End time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ) |
string (date-time) |
Query |
historianServerName |
Historian Service host name as configured in the service |
string |
Query |
intervalMS |
Interval in milliseconds. |
integer (int32) |
Query |
sampleCount |
Count of archive values within each calculation interval. |
integer (int32) |
Query |
samplingMode |
The SamplingModeType parameter is the mode of sampling data from the archive. |
enum (CurrentValue, Interpolated, Trend, RawByTime, RawByNumber, Calculated, Lab, InterpolatedToRaw, TrendToRaw, LabToRaw, RawByFilterToggling) |
Query |
startTime |
Start time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ) |
string (date-time) |
Query |
tagNames |
Historians tag name. Multiple tag names are separated by semicolons (;). Also supports wildcard character (*) in the name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< HistorianTagData«TagDataPoint«int»» > array |
400 |
Bad Request, request parameters not valid. See message for details |
|
500 |
Internal Server error, error occurred while communicating to Historian. See message for details |
2.4.2. Gets Trend Data points for the tag names specified from particular historian server based on the request parameters
GET /v1/historianTagsTrendDataPoints
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
calculationMode |
This parameter is only applied if the Sampling Mode is set to Calculated. It represents the type of calculation to use on the archive data. |
enum (Average, StandardDeviation, Total, Minimum, Maximum, Count, RawAverage, RawStandardDeviation, RawTotal, MinimumTime, MaximumTime, TimeGood, StateCount, StateTime, OPCAnd, OPCOr, FirstRawValue, FirstRawTime, LastRawValue, LastRawTime, TagStats) |
Query |
direction |
Specifies the direction (Forward (0) or Backward (1) from the starting time) of data sampling from the archive. |
integer (int32) |
Query |
endTime |
End time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ) |
string (date-time) |
Query |
historianServerName |
Historian Service host name as configured in the service |
string |
Query |
intervalMS |
Interval in milliseconds. |
integer (int32) |
Query |
sampleCount |
Count of archive values within each calculation interval. |
integer (int32) |
Query |
samplingMode |
The SamplingModeType parameter is the mode of sampling data from the archive. |
enum (CurrentValue, Interpolated, Trend, RawByTime, RawByNumber, Calculated, Lab, InterpolatedToRaw, TrendToRaw, LabToRaw, RawByFilterToggling) |
Query |
startTime |
Start time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ) |
string (date-time) |
Query |
tagNames |
Historians tag name. Multiple tag names are separated by semicolons (;). Also supports wildcard character (*) in the name |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request, request parameters not valid. See message for details |
|
500 |
Internal Server error, error occurred while communicating to Historian. See message for details |
2.5. Kpi-data-controller
KPI Data Controller
2.5.1. getKPI
GET /mesdataservice/v1/KPI
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
asset |
asset |
string |
|
Query |
interval |
interval |
string |
|
Query |
lineDescription |
lineDescription |
string |
|
Query |
lineId |
lineId |
integer (int64) |
|
Query |
name |
name |
string |
|
Query |
oEEType |
oEEType |
string |
|
Query |
pageNumber |
pageNumber |
integer (int64) |
|
Query |
pageSize |
pageSize |
integer (int64) |
|
Query |
sortCol |
sortCol |
string |
|
Query |
sortOrder |
sortOrder |
string |
|
Query |
unitId |
unitId |
integer (int64) |
2.5.2. getKPIData
GET /mesdataservice/v1/KPIData
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
inputId |
inputId |
integer (int64) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
kpiType |
kpiType |
string |
|
Query |
level |
level |
string |
|
Query |
startTime |
startTime |
string (date-time) |
2.6. Process-order-data-controller
Process Order Data Controller
2.6.1. getProcessOrderData
GET /mesdataservice/v1/processorder
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
asset |
asset |
string |
|
Query |
bom |
bom |
integer (int64) |
|
Query |
departmentId |
departmentId |
integer (int64) |
|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
lineId |
lineId |
integer (int64) |
|
Query |
name |
name |
string |
|
Query |
pageNumber |
pageNumber |
integer (int64) |
|
Query |
pageSize |
pageSize |
integer (int64) |
|
Query |
product |
product |
string |
|
Query |
quantity |
quantity |
string |
|
Query |
sortCol |
sortCol |
string |
|
Query |
sortOrder |
sortOrder |
string |
|
Query |
startTime |
startTime |
string (date-time) |
|
Query |
status |
status |
string |
|
Query |
unitId |
unitId |
integer (int64) |
2.6.2. getProcessOrderVariableSpecificationLimit
GET /mesdataservice/v1/processorder/ProcessOrderVariableSpecificationLimit
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isLive |
isLive |
boolean |
|
Query |
startTime |
startTime |
string (date-time) |
|
Query |
variable |
variable |
integer (int64) |
2.6.3. getAdjacentProcessOrderData
GET /mesdataservice/v1/processorder/adjacentprocessorderdata
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
Query |
productionPlanStartId |
productionPlanStartId |
integer (int64) |
Query |
startTime |
startTime |
string (date-time) |
2.6.4. getProcressOrderProductData
GET /mesdataservice/v1/processorder/adjecentProcessOrderProduct
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
productionPlanStartId |
productionPlanStartId |
integer (int64) |
|
Query |
startTime |
startTime |
string (date-time) |
2.6.5. getProcessOrderProductTraverse
GET /mesdataservice/v1/processorder/processOrderProductTraverse
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
nextOrPrevious |
nextOrPrevious |
string |
|
Query |
productionPlanStartId |
productionPlanStartId |
integer (int64) |
|
Query |
startTime |
startTime |
string (date-time) |
2.6.6. getNextOrPreviousProcessOrder
GET /mesdataservice/v1/processorder/processordertraverse
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
nextOrPrevious |
nextOrPrevious |
string |
|
Query |
productionPlanStartId |
productionPlanStartId |
integer (int64) |
|
Query |
startTime |
startTime |
string (date-time) |
2.7. Product-data-controller
Product Data Controller
2.7.1. getProductData
GET /mesdataservice/v1/products
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
event |
event |
integer (int64) |
|
Query |
isIncremental |
isIncremental |
integer (int64) |
|
Query |
startTime |
startTime |
string (date-time) |
2.8. Site-name-controller
Site Name Controller
2.9. Tag-data-controller
Tag Data Controller
2.9.1. getTagsBasedOnCriteria
GET /mesdataservice/v1/tags
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
aliasName |
aliasName |
string |
|
Query |
asset |
asset |
string |
|
Query |
dataSource |
dataSource |
string |
|
Query |
dataType |
dataType |
string |
|
Query |
departmentId |
departmentId |
integer (int64) |
|
Query |
interval |
interval |
string |
|
Query |
lineId |
lineId |
integer (int64) |
|
Query |
pageNumber |
pageNumber |
integer (int64) |
|
Query |
pageSize |
pageSize |
integer (int64) |
|
Query |
sampleType |
sampleType |
string |
|
Query |
sortCol |
sortCol |
string |
|
Query |
sortOrder |
sortOrder |
string |
|
Query |
tagDescription |
tagDescription |
string |
|
Query |
tagName |
tagName |
string |
|
Query |
unitId |
unitId |
integer (int64) |
|
Query |
variableGroupId |
variableGroupId |
integer (int64) |
|
Query |
variables |
variables |
string |
2.10. Variable-data-controller
Variable Data Controller
2.10.1. Get SPC Chart Data by variable id
GET /mesdataservice/v1/variabledata
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
Query |
lastKnownValue |
Flag to tell the api to fetch the latest test record(as per the result_on column of Tests table) within the start and end time supplied. |
boolean |
Query |
plotFor |
Introduced to support spc |
string |
Query |
resultOn |
result_on column value of tests table |
string (date-time) |
Query |
startTime |
startTime |
string (date-time) |
Query |
variable |
var_id from tests table |
integer (int64) |
2.10.2. Get Variable specification limit within a time range
GET /mesdataservice/v1/variabledata/VariableSpecificationLimit
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
isLive |
isLive |
boolean |
|
Query |
startTime |
startTime |
string (date-time) |
|
Query |
variable |
variable |
integer (int64) |
2.10.3. Comparison Operators
GET /mesdataservice/v1/variabledata/comparisonoperators
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 |
2.10.4. Data_Source
GET /mesdataservice/v1/variabledata/datasource
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 |
2.10.5. Sampling Type
GET /mesdataservice/v1/variabledata/samplingtype
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 |
2.10.6. Search variables based on input parameters
GET /mesdataservice/v1/variabledata/variables
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
asset |
asset |
string |
|
Query |
departmentId |
departmentId |
integer (int64) |
|
Query |
interval |
interval |
string |
|
Query |
lineId |
lineId |
integer (int64) |
|
Query |
name |
name |
string |
|
Query |
pageNumber |
pageNumber |
integer (int64) |
|
Query |
pageSize |
pageSize |
integer (int64) |
|
Query |
sample |
sample |
string |
|
Query |
sortCol |
sortCol |
string |
|
Query |
sortOrder |
sortOrder |
string |
|
Query |
source |
source |
string |
|
Query |
tagIn |
tagIn |
string |
|
Query |
tagOut |
tagOut |
string |
|
Query |
type |
type |
string |
|
Query |
unitId |
unitId |
integer (int64) |
|
Query |
varGroupId |
varGroupId |
integer (int64) |
|
Query |
variableIds |
variableIds |
< integer (int64) > array(multi) |
2.10.7. Get SPC Chart Data by variable id
GET /mesdataservice/v1/variabledata/{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. AliasNameResource
| Name | Schema |
|---|---|
aliasName |
string |
id |
integer (int32) |
links |
< Link > array |
3.3. BatchData
| Name | Schema |
|---|---|
batchDetails |
|
id |
integer (int64) |
productionDetails |
3.4. BatchDetails
| Name | Schema |
|---|---|
content |
< EntityModel«BatchData» > array |
filterData |
|
id |
integer (int64) |
page |
3.5. BatchFilterData
| Name | Schema |
|---|---|
asset |
< IdNameValue > array |
product |
< IdNameValue > array |
status |
< IdNameValue > array |
3.6. BatchInfo
| Name | Schema |
|---|---|
batch |
|
bom |
integer (int32) |
endTime |
string (date-time) |
goldenBatchId |
integer (int64) |
id |
integer (int64) |
quantity |
number (double) |
startTime |
string (date-time) |
status |
|
uom |
string |
utcTimeStamp |
3.7. ComparisonOperators
| Name | Schema |
|---|---|
comparisonOperatorId |
integer (int64) |
comparisonOperatorValue |
string |
stringComparisonOperatorSQL |
string |
stringComparisonOperatorsVB |
string |
3.8. ComparisonOperatorsData
| Name | Schema |
|---|---|
comparisonOperatorsData |
< ComparisonOperators > array |
3.9. DataSource
| Name | Schema |
|---|---|
clientId |
string |
clientSecret |
string |
port |
string |
serverName |
string |
source |
string |
uaaOrigin |
string |
uaaPort |
string |
3.10. DataSourceInfo
| Name | Schema |
|---|---|
active |
integer (int32) |
bulkImport |
integer (int32) |
dsDesc |
string |
dsId |
integer (int64) |
3.11. DataSourceValues
| Name | Schema |
|---|---|
dataSourceInfo |
< DataSourceInfo > array |
3.12. DataValue
| Name | Schema |
|---|---|
quality |
boolean |
testId |
integer (int64) |
timeStamp |
string (date-time) |
value |
string |
3.13. DeleteHistorianResource
| Name | Schema |
|---|---|
links |
< Link > array |
3.14. EntityModel«BatchData»
| Name | Schema |
|---|---|
batchDetails |
|
id |
integer (int64) |
links |
< Link > array |
productionDetails |
3.15. EntityModel«VariableDetails»
| Name | Schema |
|---|---|
dataSource |
|
dataType |
|
department |
|
engUnits |
string |
eventType |
integer (int32) |
group |
|
inputTag |
string |
interval |
integer (int64) |
line |
|
links |
< Link > array |
outputTag |
string |
type |
|
unit |
|
userDefinedDesc1 |
string |
userDefinedDesc2 |
string |
userDefinedDesc3 |
string |
variable |
3.17. FilterData
| Name | Schema |
|---|---|
asset |
< IdNameValue > array |
dataSource |
< IdNameValue > array |
dataType |
< IdNameValue > array |
interval |
< IdNameValue > array |
samplingType |
< IdNameValue > array |
variable |
< IdNameValue > array |
3.18. Historian
| Name | Schema |
|---|---|
active |
boolean |
alias |
string |
histDefault |
boolean |
histId |
integer (int64) |
histPassword |
string |
histPassword2 |
string |
histServername |
string |
histTypeDesc |
string |
histTypeDllName |
string |
histTypeId |
integer (int64) |
histUsername |
string |
osDesc |
string |
osId |
integer (int64) |
remote |
boolean |
3.19. HistorianInfo
| Name | Schema |
|---|---|
active |
boolean |
alias |
string |
histDefault |
boolean |
histPassword |
string |
histServername |
string |
histTypeId |
integer (int32) |
histUsername |
string |
id |
integer (int32) |
osId |
integer (int32) |
remote |
boolean |
3.20. HistorianInfoResource
| Name | Schema |
|---|---|
active |
boolean |
alias |
string |
histDefault |
boolean |
histPassword |
string |
histServername |
string |
histTypeId |
integer (int32) |
histUsername |
string |
id |
integer (int32) |
links |
< Link > array |
osId |
integer (int32) |
remote |
boolean |
3.21. HistorianOptionData
| Name | Schema |
|---|---|
fieldTypeDesc |
string |
fieldTypeId |
integer (int64) |
histOptionDesc |
string |
histOptionId |
integer (int64) |
spLookup |
integer (int64) |
storeId |
integer (int64) |
value |
string |
valueText |
string |
3.22. HistorianOptionInfo
| Name | Schema |
|---|---|
active |
boolean |
alias |
string |
remote |
boolean |
3.23. HistorianOptionResource
| Name | Schema |
|---|---|
historianOptionData |
< HistorianOptionData > array |
historianOptionInfo |
< HistorianOptionInfo > array |
links |
< Link > array |
3.24. HistorianPage
| Name | Schema |
|---|---|
content |
< HistorianResource > array |
links |
< Link > array |
page |
3.25. HistorianResource
| Name | Schema |
|---|---|
active |
boolean |
alias |
string |
histDefault |
boolean |
histId |
integer (int64) |
histPassword |
string |
histPassword2 |
string |
histServername |
string |
histTypeDesc |
string |
histTypeDllName |
string |
histTypeId |
integer (int64) |
histUsername |
string |
links |
< Link > array |
osDesc |
string |
osId |
integer (int64) |
remote |
boolean |
3.26. HistorianTagData«List«TagDataPoint«boolean»»»
Encapsulates the Tag specific properties and data
| Name | Description | Schema |
|---|---|---|
dataType |
Data type of this tag |
string |
errorCode |
Error code if any as given from Historian service, 0 mean success |
integer (int32) |
tagDataPoints |
Data points for this tag |
< < TagDataPoint«boolean» > array > array |
tagName |
The name of the Historian Tag |
string |
3.27. HistorianTagData«TagDataPoint«int»»
Encapsulates the Tag specific properties and data
| Name | Description | Schema |
|---|---|---|
dataType |
Data type of this tag |
string |
errorCode |
Error code if any as given from Historian service, 0 mean success |
integer (int32) |
tagDataPoints |
Data points for this tag |
< TagDataPoint«int» > array |
tagName |
The name of the Historian Tag |
string |
3.28. HistorianTypePage
| Name | Schema |
|---|---|
content |
< HistorianTypeResource > array |
links |
< Link > array |
page |
3.29. HistorianTypeResource
| Name | Schema |
|---|---|
histTypeDesc |
string |
histTypeDllName |
string |
histTypeId |
integer (int64) |
links |
< Link > array |
3.30. HistorianTypes
| Name | Schema |
|---|---|
histTypeDesc |
string |
histTypeDllName |
string |
histTypeId |
integer (int64) |
3.31. Historians
| Name | Schema |
|---|---|
historianList |
< Historian > array |
historianTypeList |
< HistorianTypes > array |
operatingSystemList |
< OperatingSystems > array |
3.32. HistoriansInfo
| Name | Schema |
|---|---|
alias |
string |
dataSource |
|
isDefault |
boolean |
serverName |
string |
3.35. 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.36. OperatingSystemPage
| Name | Schema |
|---|---|
content |
< OperatingSystemResource > array |
links |
< Link > array |
page |
3.37. OperatingSystemResource
| Name | Schema |
|---|---|
links |
< Link > array |
osDesc |
string |
osId |
integer (int64) |
3.39. Page
| Name | Schema |
|---|---|
pageNumber |
integer (int64) |
pageSize |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.40. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.41. ProductionInfo
| Name | Schema |
|---|---|
department |
|
endTime |
string (date-time) |
id |
integer (int64) |
isAppliedProduct |
integer (int64) |
line |
|
product |
|
productUTCTimeStamp |
|
startTime |
string (date-time) |
status |
string |
unit |
3.43. SamplingTypes
| Name | Schema |
|---|---|
samplingTypesData |
< SamplingType > array |
3.45. TagDataPoint«boolean»
Data for a tag at a point of time as recieved from Historian Service
| Name | Description | Schema |
|---|---|---|
quality |
Quality of the value. This can be Bad(0), Uncertain(1), NA(2) or Good(3) |
boolean |
timeStamp |
Time when this data point is taken |
string (date-time) |
value |
Value of the Tag at a particular time |
object |
3.46. TagDataPoint«int»
Data for a tag at a point of time as recieved from Historian Service
| Name | Description | Schema |
|---|---|---|
quality |
Quality of the value. This can be Bad(0), Uncertain(1), NA(2) or Good(3) |
integer (int32) |
timeStamp |
Time when this data point is taken |
string (date-time) |
value |
Value of the Tag at a particular time |
object |
3.47. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.49. Timestamp
| Name | Schema |
|---|---|
date |
integer (int32) |
day |
integer (int32) |
hours |
integer (int32) |
minutes |
integer (int32) |
month |
integer (int32) |
nanos |
integer (int32) |
seconds |
integer (int32) |
time |
integer (int64) |
timezoneOffset |
integer (int32) |
year |
integer (int32) |
3.51. VariableData
| Name | Schema |
|---|---|
data |
< DataValue > array |
variable |
integer (int64) |
variableDescription |
string |
3.52. VariableDetails
| Name | Schema |
|---|---|
dataSource |
|
dataType |
|
department |
|
engUnits |
string |
eventType |
integer (int32) |
group |
|
inputTag |
string |
interval |
integer (int64) |
line |
|
outputTag |
string |
type |
|
unit |
|
userDefinedDesc1 |
string |
userDefinedDesc2 |
string |
userDefinedDesc3 |
string |
variable |
3.53. VariableSearchDetails
| Name | Schema |
|---|---|
content |
< EntityModel«VariableDetails» > array |
filterData |
|
id |
integer (int64) |
page |
3.54. VariableSpecificationLimit
| Name | Schema |
|---|---|
lowerControl |
string |
lowerEntry |
string |
lowerReject |
string |
lowerUser |
string |
lowerWarning |
string |
product |
integer (int64) |
productDescription |
string |
startTime |
string (date-time) |
target |
string |
targetControl |
string |
upperControl |
string |
upperEntry |
string |
upperReject |
string |
upperUser |
string |
upperWarning |
string |
variable |
integer (int64) |
3.55. WsSPCCriteriaSummary
| Name | Schema |
|---|---|
hyperlink |
string |
id |
integer (int64) |
name |
string |
value |
string |
valueParameter |
string |
3.56. WsSPCProductRunning
| Name | Description | Schema |
|---|---|---|
isBasisProduct |
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.57. 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.58. 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.59. 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.60. 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://localhost/uaa/oauth/authorize
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |