1. Overview

The service contains a collection of RESTful service calls to retrieve various information relevant to manufacturing execution.

Descriptions of these functions can be found in the section headers for each collection of relevant resources.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • batch-data-controller : Batch Data Controller

  • historian-data-controller : Historian Data 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. getBatchData

GET /mesdataservice/v1/batchdata
Parameters
Type Name Description Schema Default

Query

asset
optional

asset

string

Query

bom
optional

bom

integer (int64)

Query

departmentId
optional

departmentId

integer (int64)

Query

endTime
required

endTime

string (date-time)

Query

isGoldenBatch
optional

isGoldenBatch

boolean

"false"

Query

lineId
optional

lineId

integer (int64)

Query

name
optional

name

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

20

Query

product
optional

product

string

Query

quantity
optional

quantity

string

Query

sortCol
optional

sortCol

string

"Name"

Query

sortOrder
optional

sortOrder

string

"Asc"

Query

startTime
required

startTime

string (date-time)

Query

status
optional

status

string

Query

unitId
optional

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.2. getAdjacentBatchData

GET /mesdataservice/v1/batchdata/adjacentbatchdata
Parameters
Type Name Description Schema

Query

endTime
optional

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.1.3. getbatchProductTraverse

GET /mesdataservice/v1/batchdata/batchproducttraverse
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

nextOrPrevious
required

nextOrPrevious

string

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.4. getNextOrPreviousBatch

GET /mesdataservice/v1/batchdata/batchtraverse
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

nextOrPrevious
required

nextOrPrevious

string

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.5. getBatchRecord

DELETE /mesdataservice/v1/batchdata/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

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
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.2. getHistorianRecord

DELETE /mesdataservice/v1/historians/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.3. Historians-tag-data-controller

Historians Tag Data Controller

2.3.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
optional

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
required

Data point type end point which needs to be queried from Historian Service

enum (raw, interpolated, currentvalue, calculated, sampled)

Query

direction
optional

Specifies the direction (Forward (0) or Backward (1) from the starting time) of data sampling from the archive.

integer (int32)

Query

endTime
optional

End time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

historianServerName
required

Historian Service host name as configured in the service

string

Query

intervalMS
optional

Interval in milliseconds.

integer (int32)

Query

sampleCount
optional

Count of archive values within each calculation interval.

integer (int32)

Query

samplingMode
optional

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
optional

Start time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

tagNames
required

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

HttpErrorResponse

500

Internal Server error, error occurred while communicating to Historian. See message for details

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3.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
optional

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
optional

Specifies the direction (Forward (0) or Backward (1) from the starting time) of data sampling from the archive.

integer (int32)

Query

endTime
required

End time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

historianServerName
required

Historian Service host name as configured in the service

string

Query

intervalMS
optional

Interval in milliseconds.

integer (int32)

Query

sampleCount
optional

Count of archive values within each calculation interval.

integer (int32)

Query

samplingMode
required

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
required

Start time in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

tagNames
required

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«List«TagDataPoint«boolean»»» > array

400

Bad Request, request parameters not valid. See message for details

HttpErrorResponse

500

Internal Server error, error occurred while communicating to Historian. See message for details

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4. Kpi-data-controller

KPI Data Controller

2.4.1. getKPI

GET /mesdataservice/v1/KPI
Parameters
Type Name Description Schema Default

Query

asset
optional

asset

string

Query

interval
optional

interval

string

Query

lineDescription
optional

lineDescription

string

Query

lineId
optional

lineId

integer (int64)

Query

name
optional

name

string

Query

oEEType
optional

oEEType

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

20

Query

sortCol
optional

sortCol

string

"Name"

Query

sortOrder
optional

sortOrder

string

"Asc"

Query

unitId
optional

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.4.2. getKPIData

GET /mesdataservice/v1/KPIData
Parameters
Type Name Description Schema Default

Query

endTime
required

endTime

string (date-time)

Query

inputId
required

inputId

integer (int64)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

kpiType
required

kpiType

string

Query

level
required

level

string

Query

startTime
required

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.5. Process-order-data-controller

Process Order Data Controller

2.5.1. getProcessOrderData

GET /mesdataservice/v1/processorder
Parameters
Type Name Description Schema Default

Query

asset
optional

asset

string

Query

bom
optional

bom

integer (int64)

Query

departmentId
optional

departmentId

integer (int64)

Query

endTime
required

endTime

string (date-time)

Query

lineId
optional

lineId

integer (int64)

Query

name
optional

name

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

20

Query

product
optional

product

string

Query

quantity
optional

quantity

string

Query

sortCol
optional

sortCol

string

"Name"

Query

sortOrder
optional

sortOrder

string

"Asc"

Query

startTime
required

startTime

string (date-time)

Query

status
optional

status

string

Query

unitId
optional

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.2. getProcessOrderVariableSpecificationLimit

GET /mesdataservice/v1/processorder/ProcessOrderVariableSpecificationLimit
Parameters
Type Name Description Schema Default

Query

endTime
required

endTime

string (date-time)

Query

isLive
optional

isLive

boolean

"false"

Query

startTime
required

startTime

string (date-time)

Query

variable
required

variable

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.3. getAdjacentProcessOrderData

GET /mesdataservice/v1/processorder/adjacentprocessorderdata
Parameters
Type Name Description Schema

Query

endTime
optional

endTime

string (date-time)

Query

productionPlanStartId
required

productionPlanStartId

integer (int64)

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.5.4. getProcressOrderProductData

GET /mesdataservice/v1/processorder/adjecentProcessOrderProduct
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

productionPlanStartId
required

productionPlanStartId

integer (int64)

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.5. getProcessOrderProductTraverse

GET /mesdataservice/v1/processorder/processOrderProductTraverse
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

nextOrPrevious
required

nextOrPrevious

string

Query

productionPlanStartId
required

productionPlanStartId

integer (int64)

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.6. getNextOrPreviousProcessOrder

GET /mesdataservice/v1/processorder/processordertraverse
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

nextOrPrevious
required

nextOrPrevious

string

Query

productionPlanStartId
required

productionPlanStartId

integer (int64)

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.7. getProcessOrderRecord

DELETE /mesdataservice/v1/processorder/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.6. Product-data-controller

Product Data Controller

2.6.1. getProductData

GET /mesdataservice/v1/products
Parameters
Type Name Description Schema Default

Query

endTime
optional

endTime

string (date-time)

Query

event
required

event

integer (int64)

Query

isIncremental
optional

isIncremental

integer (int64)

0

Query

startTime
optional

startTime

string (date-time)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.7. Site-name-controller

Site Name Controller

2.7.1. getSiteName

GET /mesdataservice/v1/sitename
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.8. Tag-data-controller

Tag Data Controller

2.8.1. getTagsBasedOnCriteria

GET /mesdataservice/v1/tags
Parameters
Type Name Description Schema Default

Query

aliasName
optional

aliasName

string

"abc"

Query

asset
optional

asset

string

Query

dataSource
optional

dataSource

string

"abc"

Query

dataType
optional

dataType

string

Query

departmentId
optional

departmentId

integer (int64)

Query

interval
optional

interval

string

Query

lineId
optional

lineId

integer (int64)

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

10

Query

sampleType
optional

sampleType

string

Query

sortCol
optional

sortCol

string

"Name"

Query

sortOrder
optional

sortOrder

string

"Asc"

Query

tagDescription
optional

tagDescription

string

Query

tagName
optional

tagName

string

Query

unitId
optional

unitId

integer (int64)

Query

variableGroupId
optional

variableGroupId

integer (int64)

Query

variables
optional

variables

string
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.8.2. getTagRecord

DELETE /mesdataservice/v1/tags/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.9. Variable-data-controller

Variable Data Controller

2.9.1. getVariablesData

GET /mesdataservice/v1/variabledata
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

startTime
required

startTime

string (date-time)

Query

variable
required

variable

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.9.2. getVariableSpecificationLimit

GET /mesdataservice/v1/variabledata/VariableSpecificationLimit
Parameters
Type Name Description Schema Default

Query

endTime
required

endTime

string (date-time)

Query

isLive
optional

isLive

boolean

"false"

Query

startTime
required

startTime

string (date-time)

Query

variable
required

variable

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.9.3. getVariableBasedOnCriteria

GET /mesdataservice/v1/variabledata/variables
Parameters
Type Name Description Schema Default

Query

asset
optional

asset

string

Query

departmentId
optional

departmentId

integer (int64)

Query

interval
optional

interval

string

Query

lineId
optional

lineId

integer (int64)

Query

name
optional

name

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

20

Query

sample
optional

sample

string

Query

sortCol
optional

sortCol

string

"Name"

Query

sortOrder
optional

sortOrder

string

"Asc"

Query

source
optional

source

string

Query

tagIn
optional

tagIn

string

Query

tagOut
optional

tagOut

string

Query

type
optional

type

string

Query

unitId
optional

unitId

integer (int64)

Query

varGroupId
optional

varGroupId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

3. Definitions

3.1. DataSource

Name Schema

clientId
optional

string

clientSecret
optional

string

port
optional

string

serverName
optional

string

source
optional

string

uaaOrigin
optional

string

uaaPort
optional

string

3.2. Error

Name Schema

code
optional

string

details
optional

object

3.3. HistorianTagData«List«TagDataPoint«boolean»»»

Encapsulates the Tag specific properties and data

Name Description Schema

dataType
optional

Data type of this tag

string

errorCode
optional

Error code if any as given from Historian service, 0 mean success

integer (int32)

tagDataPoints
optional

Data points for this tag

< < TagDataPoint«boolean» > array > array

tagName
optional

The name of the Historian Tag

string

3.4. HistorianTagData«TagDataPoint«int»»

Encapsulates the Tag specific properties and data

Name Description Schema

dataType
optional

Data type of this tag

string

errorCode
optional

Error code if any as given from Historian service, 0 mean success

integer (int32)

tagDataPoints
optional

Data points for this tag

< TagDataPoint«int» > array

tagName
optional

The name of the Historian Tag

string

3.5. HistoriansInfo

Name Schema

alias
optional

string

dataSource
optional

DataSource

isDefault
optional

boolean

serverName
optional

string

3.6. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.7. TagDataPoint«boolean»

Data for a tag at a point of time as recieved from Historian Service

Name Description Schema

quality
optional

Quality of the value. This can be Bad(0), Uncertain(1), NA(2) or Good(3)
Example : false

boolean

timeStamp
optional

Time when this data point is taken

string (date-time)

value
optional

Value of the Tag at a particular time

object

3.8. TagDataPoint«int»

Data for a tag at a point of time as recieved from Historian Service

Name Description Schema

quality
optional

Quality of the value. This can be Bad(0), Uncertain(1), NA(2) or Good(3)

integer (int32)

timeStamp
optional

Time when this data point is taken

string (date-time)

value
optional

Value of the Tag at a particular time

object

4. Security

4.1. oauth

Type : oauth2
Flow : accessCode
Token URL : http://localhost:0000/uaa/oauth/authorize
Token URL : http://localhost:0000/uaa/oauth/token

Name Description

default

Default oauth2 scope.