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

  • favorite-chart-controller : Favorite Chart Controller

  • historian-data-controller : Historian Data Controller

  • kpi-data-controller : KPI Data Controller

  • plant-model-controller : Plant Model Controller

  • product-data-controller : Product Data 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. getAdjacentBatchData

GET /chart-editor/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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.2. getBatchData

GET /chart-editor/BatchData
Parameters
Type Name Description Schema Default

Query

asset
required

asset

string

Query

bom
required

bom

integer (int64)

Query

departmentId
required

departmentId

integer (int64)

Query

endTime
required

endTime

string (date-time)

Query

isGoldenBatch
required

isGoldenBatch

boolean

Query

lineId
required

lineId

integer (int64)

Query

name
required

name

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

10

Query

product
required

product

string

Query

quantity
required

quantity

string

Query

sortCol
optional

sortCol

string

"name"

Query

sortOrder
optional

sortOrder

string

"asc"

Query

startTime
required

startTime

string (date-time)

Query

status
required

status

string

Query

unitId
required

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.3. getBatchProductTraversalInfo

GET /chart-editor/batchproducttraverse
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

isIncremental
required

isIncremental

integer (int64)

Query

nextOrPrevious
required

nextOrPrevious

string

Query

startTime
required

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 /chart-editor/batchtraverse
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

isIncremental
required

isIncremental

integer (int64)

Query

nextOrPrevious
required

nextOrPrevious

string

Query

startTime
required

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.2. Favorite-chart-controller

Favorite Chart Controller

2.2.1. GetFavorite

GET /chart-editor/Favorite
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.2. SaveFavorite

POST /chart-editor/Favorite/SaveFavorite
Parameters
Type Name Description Schema

Body

favoriteDetail
required

favoriteDetail

FavoriteDetail
Responses
HTTP Code Description Schema

200

OK

object
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.2.3. GetFavoriteDetails

GET /chart-editor/Favorite/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.4. DeleteFavorite

DELETE /chart-editor/Favorite/{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. Historian-data-controller

Historian Data Controller

2.3.1. getHistoriansInfo

GET /chart-editor/historians
Responses
HTTP Code Description Schema

200

OK

object
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 /chart-editor/KPI
Parameters
Type Name Description Schema Default

Query

asset
required

asset

string

Query

interval
required

interval

string

Query

lineDescription
required

lineDescription

string

Query

lineId
required

lineId

integer (int64)

Query

name
required

name

string

Query

oEEType
required

oEEType

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

10

Query

sortCol
optional

sortCol

string

"name"

Query

sortOrder
optional

sortOrder

string

"asc"

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.4.2. getKPIData

GET /chart-editor/KPIData
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

inputId
required

inputId

integer (int64)

Query

isIncremental
required

isIncremental

integer (int64)

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. Plant-model-controller

Plant Model Controller

2.5.1. getPlantModelInfo

GET /chart-editor/PlantModel
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.2. getLineInfoForDept

GET /chart-editor/department/{departmentId}/lines
Parameters
Type Name Description Schema

Path

departmentId
required

departmentId

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. getUnitInfoForLine

GET /chart-editor/line/{lineId}/units
Parameters
Type Name Description Schema

Path

lineId
required

lineId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6. Product-data-controller

Product Data Controller

2.6.1. getProductData

GET /chart-editor/ProductData
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

eventId
required

eventId

integer (int64)

Query

isIncremental
required

isIncremental

integer (int64)

Query

startTime
required

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. Tag-data-controller

Tag Data Controller

2.7.1. getTagsBasedOnSearchCriteria

GET /chart-editor/Tags
Parameters
Type Name Description Schema Default

Query

aliasName
optional

aliasName

string

"abc"

Query

asset
required

asset

string

Query

dataSource
optional

dataSource

string

"abc"

Query

dataType
required

dataType

string

Query

departmentId
required

departmentId

integer (int64)

Query

interval
required

interval

string

Query

lineId
required

lineId

integer (int64)

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

10

Query

sampleType
required

sampleType

string

Query

sortCol
optional

sortCol

string

Query

sortOrder
optional

sortOrder

string

Query

tagDescription
required

tagDescription

string

Query

tagName
required

tagName

string

Query

unitId
required

unitId

integer (int64)

Query

variableGroupId
required

variableGroupId

integer (int64)

Query

variables
required

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. Variable-data-controller

Variable Data Controller

2.8.1. getVariableData

GET /chart-editor/VariableData
Parameters
Type Name Description Schema

Query

endTime
required

endTime

string (date-time)

Query

startTime
required

startTime

string (date-time)

Query

variableId
required

variableId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.8.2. getVariableSpecificationLimits

GET /chart-editor/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

variableId
required

variableId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.8.3. getVariablesBasedOnSearchCriteria

GET /chart-editor/Variables
Parameters
Type Name Description Schema Default

Query

asset
required

asset

string

Query

departmentId
required

departmentId

integer (int64)

Query

interval
required

interval

string

Query

lineId
required

lineId

integer (int64)

Query

name
required

name

string

Query

pageNumber
optional

pageNumber

integer (int64)

1

Query

pageSize
optional

pageSize

integer (int64)

10

Query

sample
required

sample

string

Query

sortCol
optional

sortCol

string

"name"

Query

sortOrder
optional

sortOrder

string

"asc"

Query

source
required

source

string

Query

tagIn
required

tagIn

string

Query

tagOut
required

tagOut

string

Query

type
required

type

string

Query

unitId
required

unitId

integer (int64)

Query

varGroupId
required

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. FavoriteDetail

Name Schema

data
optional

< string, object > map

idValue
optional

integer (int64)

links
optional

< Link > array

name
optional

string

3.2. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

4. Security

4.1. oauth

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

Name Description

default

Default oauth2 scope.