1. Overview

Microservice containing the business logic for managing productionmetrics-app-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • asset-controller : Asset Controller

  • availability-controller : Availability Controller

  • common-plant-controller : Common Plant Controller

  • metrics-controller : Metrics Controller

  • performance-controller : Performance Controller

  • quality-controller : Quality Controller

  • reports-metrics-controller : Reports Metrics Controller

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Asset-controller

Asset Controller

2.1.1. Fetch all Departments in the Plant Floor

GET /production-metrics-viewer/departments
Responses
HTTP Code Description Schema

200

OK

DepartmentsResource

204

No Content

DepartmentsResource

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

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. Fetch lines based on the departmentId provided. If departmentId is not provided, it will return all lines in all departments

GET /production-metrics-viewer/lines
Parameters
Type Name Description Schema

Query

departmentId
optional

Department Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

LineAssetsResource

204

No Content

LineAssetsResource

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

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. Fetch units based on the lineId provided. If lineId is not provided, it will return all units in all lines

GET /production-metrics-viewer/units
Parameters
Type Name Description Schema

Query

lineId
optional

Line Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

UnitAssetsResource

204

No Content

UnitAssetsResource

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

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. Availability-controller

Availability Controller

2.2.1. Fetch all downtime categories based on the specified unitIds and selected timerange

GET /production-metrics-viewer/categories
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

oeeParameter
optional

Define the type of downtime whether it is Availability, Performance or Quality, required in case OEE mode of unit is time based.

enum (Availability, Quality, Performance)

Query

showTopNBars
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int64)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

1

Query

unitList
required

Comma separated unit ids

string
Responses
HTTP Code Description Schema

200

OK

AvailabilityCategoryResource

204

No Content

AvailabilityCategoryResource

400

Bad Request

No Content

404

Not Found

No Content

500

Internal Server Error

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.2. Fetch the downtime records based on the specified unitIds and selected timerange

GET /production-metrics-viewer/events/line/{lineId}
Parameters
Type Name Description Schema Default

Path

lineId
required

Line Id

integer (int32)

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

machineId
required

Comma separated unit ids

string

Query

oeeParameter
optional

Define the type of downtime whether it is Availability, Performance or Quality, required in case OEE mode of unit is time based.

string

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

20

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

LineDistributionResponseResource

204

No Content

LineDistributionResponseResource

400

Bad Request

No Content

404

Not Found

No Content

500

Internal Server Error

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.3. Fetch the downtime records based on the specified unit and timeselection

GET /production-metrics-viewer/events/machine/{equipmentId}
Parameters
Type Name Description Schema Default

Path

equipmentId
required

Unit Id

integer (int32)

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

oeeParameter
optional

Define the type of downtime whether it is Availability, Performance or Quality, required in case OEE mode of unit is time based.

string

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

20

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

LineDistributionResponseResource

204

No Content

LineDistributionResponseResource

400

Bad Request

No Content

404

Not Found

No Content

500

Internal Server Error

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.4. Fetch Mean Time To Repair (MTTR) and Mean Time Before Failure (MTBF) based on the specified unitIds and selected timerange

GET /production-metrics-viewer/mttr-mtbf
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

lineId
optional

Line Id

integer (int32)

Query

oeeParameter
optional

Define the type of downtime whether it is Availability, Performance or Quality, required in case OEE mode of unit is time based.

enum (Availability, Quality, Performance)

Query

showTopNBars
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

AvailabilitySummary1Resource

204

No Content

AvailabilitySummary1Resource

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

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.5. Fetch all downtime Reasons based on the specified unitIds and selected timerange

GET /production-metrics-viewer/reasons
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

oeeParameter
optional

Define the type of downtime whether it is Availability, Performance or Quality, required in case OEE mode of unit is time based.

string

Query

showTopNBars
optional

Number of top level reasons (reason1) to be returned, default to 5

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

0

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

AvailabilityCategoryResource

204

No Content

AvailabilityCategoryResource

400

Bad Request

No Content

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

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.3. Common-plant-controller

Common Plant Controller

2.3.1. Returns list of Crews configured in the PlantApps

GET /production-metrics-viewer/crews
Responses
HTTP Code Description Schema

200

OK

CrewsResource

204

No Content

CrewsResource
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.2. Return list of Shifts Configured in the PlantApps

GET /production-metrics-viewer/shifts
Responses
HTTP Code Description Schema

200

OK

S88RShiftsResource

204

No Content

S88RShiftsResource
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.3. Fetch the timerange based on the selected timeselection

GET /production-metrics-viewer/time-selection
Parameters
Type Name Description Schema

Query

equipmentId
optional

Comma separated unit ids

< string > array(multi)

Query

equipmentType
optional

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

TimeSelectionResource

204

No Content

TimeSelectionResource
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Metrics-controller

Metrics Controller

2.4.1. Fetch the values of OEE, Quality, Performance and Availability based on the specified equipmentType and timeselection

GET /production-metrics-viewer
Caution

operation.deprecated
Parameters
Type Name Description Schema Default

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
optional

Unit Id

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

filterType
optional

Filter Type. This is not being used and will be deprecated soon.

integer (int32)

0

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

100

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

AssetMetricDataResource

204

No Content

AssetMetricDataResource

404

Not Found

No Content

500

Internal Server Error

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.4.2. Fetch the values of OEE, Quality, Performance and Availability based on the specified equipmentType and timeselection

GET /production-metrics-viewer/counts/downtimes
Caution

operation.deprecated
Parameters
Type Name Description Schema Default

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

filterType
optional

Filter Type. This is not being used and will be deprecated soon.

integer (int32)

0

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

100

Query

resultType
optional

Result Type - 0 with summarize = 0 to get KPI for lines, 0 with summarize = 1 to get combined KPI of all specified units , 1 to get KPI for lines. Not required in case of Unit equipment type

integer (int32)

3

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

AssetMetricData1Resource

204

No Content

AssetMetricData1Resource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.3. Fetch the values of OEE, Quality, Performance and Availability based on the specified equipmentType and timeselection

GET /production-metrics-viewer/counts/downtimes/v2
Parameters
Type Name Description Schema Default

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

filterType
optional

Filter Type. This is not being used and will be deprecated soon.

integer (int32)

0

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

100

Query

resultType
optional

Result Type - 0 with summarize = 0 to get KPI for lines, 0 with summarize = 1 to get combined KPI of all specified units , 1 to get KPI for lines. Not required in case of Unit equipment type

integer (int32)

3

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

AssetMetricDataPagedResource

204

No Content

AssetMetricDataPagedResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.4. Fetch ideal production, net production, production amount based on the timeselection

GET /production-metrics-viewer/counts/parts
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

machineId
required

Comma separated unit ids

integer (int32)

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

20

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

UnitMetricsDataResponseResource

204

No Content

UnitMetricsDataResponseResource

404

Not Found

No Content

500

Internal Server Error

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.4.5. Fetch the values of OEE, Quality, Performance and Availability based on the specified equipmentType and timeselection

GET /production-metrics-viewer/v2
Parameters
Type Name Description Schema Default

Query

ascDesc
optional

0 for sort by OEE percentage, 1 for sort by PerformanceRate, 2 for sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription

integer (int32)

0

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
optional

Unit Id

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

filterType
optional

Filter Type. This is not being used and will be deprecated soon.

integer (int32)

0

Query

pageNum
optional

Fetch the Nth page records

integer (int32)

1

Query

pageSize
optional

Number of records per page, from 1 to 500

integer (int32)

100

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int32)

0

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

AssetMetricDataPagedResource

204

No Content

AssetMetricDataPagedResource

404

Not Found

No Content

500

Internal Server Error

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.5. Performance-controller

Performance Controller

2.5.1. Fetch categories for performance based on the Unitlist, Timeselection, ShowtopNBars, FilterNPT

GET /production-metrics-viewer/performance/categories
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int64)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

1

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

PerformanceCategoryResource

204

No Content

PerformanceCategoryResource

404

Not Found

No Content

500

Internal Server Error

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.5.2. Fetch reasons for Speed Loss Breakdown based on the Unitlist, Timeselection, ShowtopNBars, FilterNPT

GET /production-metrics-viewer/performance/reasons
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Number of top level reasons (reason1) to be returned, default to 5

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

0

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

PerformanceSummaryResource

204

No Content

PerformanceSummaryResource

404

Not Found

No Content

500

Internal Server Error

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.6. Quality-controller

Quality Controller

2.6.1. Fetchs reasons,categories and Mean Amount Per Event (MAPE) and Mean Amount Between Events(MABE) based on Unitlist, Timeselection

GET /production-metrics-viewer/quality
Parameters
Type Name Description Schema Default

Query

calculateMapeMabe
optional

Whether to calculate and include mape mabe in the response

boolean

"false"

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Number of top level reasons (reason1) to be returned, default to 5

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

0

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

QualitySummaryDetailResource

204

No Content

QualitySummaryDetailResource

500

Internal Server Error

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.6.2. Fetch categories for scrap breakdown based on Unitlist, Timeselection

GET /production-metrics-viewer/quality/categories
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

1

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

QualityCategoryResource

204

No Content

QualityCategoryResource

404

Not Found

No Content

500

Internal Server Error

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.6.3. Mean Amount Per Event (MAPE) and Mean Amount Between Events(MABE) based on the specified unitIds and selected timerange

GET /production-metrics-viewer/quality/mape-mabe
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

1

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

QualityCategoryResource

204

No Content

QualityCategoryResource

404

Not Found

No Content

500

Internal Server Error

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.6.4. Fetch reasons for scrap breakdown based on Unitlist, Timeselection

GET /production-metrics-viewer/quality/reasons
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

showTopNBars
optional

Number of top level reasons (reason1) to be returned, default to 5

integer (int64)

Query

sortOrder
optional

Sort order by KPI, 1 - Performance 2 - Quality 3 - Availability

integer (int64)

1

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

Query

toggle
optional

Please leave this field blank, This parameter is not being used. It will be deprecated later.

integer (int64)

0

Query

unitList
required

Semicolon separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

QualitySummaryResource

204

No Content

QualitySummaryResource

404

Not Found

No Content

500

Internal Server Error

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.7. Reports-metrics-controller

Reports Metrics Controller

2.7.1. Fetches the KPI values including OEE, Quality, Performance and Availability based on the timeselection, equipmentIds

GET /production-reports-viewer/machines/oee/summary
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

summarize
required

If true, summarizes all the KPI values including OEE, Quality, Performance and Availability

string

"1"

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

OverallUnitOEEResource

204

No Content

OverallUnitOEEResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.2. Fetches the oeeMode status for calculating product oee summary

GET /production-reports-viewer/oee/mode
Parameters
Type Name Description Schema

Query

lineId
optional

Line Id

integer (int32)
Responses
HTTP Code Description Schema

200

OK

OeeModeInfoResource

204

No Content

OeeModeInfoResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.3. Fetches the KPI values including OEE, Quality, Performance and Availability based on the timeselection, equipmentIds

GET /production-reports-viewer/oee/summary
Parameters
Type Name Description Schema Default

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

equipmentId
optional

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

OeeSummaryResource

204

No Content

OeeSummaryResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.4. Fetches the Order OEE summary based on the timeselection, equipmentIds

GET /production-reports-viewer/order
Parameters
Type Name Description Schema Default

Query

endTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

groupBy
required

Group results by 1 for No grouping, 2 for Shift , 3 for Crew , 4 for Path

integer (int32)

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductOrderOeeResource

204

No Content

ProductOrderOeeResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.5. Fetches the Product OEE summary based on the timeselection, equipmentIds

GET /production-reports-viewer/product
Parameters
Type Name Description Schema Default

Query

endTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

filterNpt
optional

Include Non productive time when set to false and exclude it when set to true.

boolean

"false"

Query

groupBy
required

Group results by 1 for No grouping, 2 for Shift , 3 for Crew , 4 for Path

integer (int32)

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductOrderOeeResource

204

No Content

ProductOrderOeeResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.6. Fetches the Production Status details based on the timeselection, equipmentIds

GET /production-reports-viewer/production-status
Parameters
Type Name Description Schema

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

equipmentId
required

Comma separated unit ids

string

Query

equipmentType
required

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

groupBy
required

Group results by 1 for No grouping, 2 for Shift , 3 for Crew , 4 for Path

integer (int32)

Query

pageNum
optional

Fetch the Nth page records

string

Query

pageSize
optional

Number of records per page, from 1 to 500

string

Query

pathList
optional

Comma separated list of paths

string

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductionStatusResponseResource

204

No Content

ProductionStatusResponseResource

404

Not Found

No Content

500

Internal Server Error

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8. User-settings-controller

User Settings Controller

2.8.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

Conflict, User Setting already exists. Use a PUT to update

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

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.8.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
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.8.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, There is no saved User settings for the logged in user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

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.8.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
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.8.5. Get Privilege Sets

GET /v2/settings/apps
Parameters
Type Name Description Schema

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
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. AssetInfo

Name Schema

assetId
optional

integer (int64)

assetType
optional

string

identifier
optional

integer (int64)

name
optional

string

3.2. AssetMetricData

Name Schema

availableRate
optional

number (double)

line
optional

string

lineAssets
optional

< AssetInfo > array

lineId
optional

integer (int32)

oeeMode
optional

integer (int32)

percentOEE
optional

number (double)

performanceRate
optional

number (double)

qualityRate
optional

number (double)

unitDesc
optional

string

unitId
optional

integer (int32)

unitsCount
optional

integer (int32)

3.3. AssetMetricData1Resource

Name Schema

content
optional

< Resource«AssetMetricData» > array

links
optional

< Link > array

page
optional

PageMetadata

3.4. AssetMetricDataPagedResource

Name Schema

assetMetricDataList
optional

< AssetMetricData > array

links
optional

< Link > array

pageNum
optional

integer (int32)

pageSize
optional

integer (int32)

remainingPages
optional

integer (int32)

3.5. AssetMetricDataResource

Name Schema

availableRate
optional

number (double)

line
optional

string

lineAssets
optional

< AssetInfo > array

lineId
optional

integer (int32)

links
optional

< Link > array

oeeMode
optional

integer (int32)

percentOEE
optional

number (double)

performanceRate
optional

number (double)

qualityRate
optional

number (double)

unitDesc
optional

string

unitId
optional

integer (int32)

unitsCount
optional

integer (int32)

3.6. AvailabilityCategoryDistribution

Name Schema

events
optional

integer (int32)

name
optional

string

totalTime
optional

number (float)

3.7. AvailabilityCategoryResource

Name Schema

categoryByDuration
optional

< AvailabilityCategoryDistribution > array

categoryByEvent
optional

< AvailabilityCategoryDistribution > array

links
optional

< Link > array

3.8. AvailabilityDistribution

Name Description Schema

events
optional

The events data of this availability distribution

integer (int32)

faults
optional

The faults data of this availability distribution

string

mtbf
optional

The mean time between failure of this availability distribution

string

mttr
optional

The mean time to repair of this availability distribution in hh:mm:ss format

string

name
optional

The Level name of this availability distribution

string

quality
optional

The quality data of this availability distribution

string

totalTime
optional

The total time duration for this availability distribution

number (float)

3.9. AvailabilitySummary1Resource

Name Schema

links
optional

< Link > array

location
optional

< AvailabilityDistribution > array

reason1
optional

< AvailabilityDistribution > array

3.10. CrewsResource

Name Description Schema

crewDesc
optional

The list of Crew, when the downtime occurred

< string > array

links
optional

< Link > array

3.11. DepartmentsResource

Name Schema

depts
optional

< Resource«AssetInfo» > array

links
optional

< Link > array

3.12. DowntimeCategory

Name Schema

id
optional

string

name
optional

string

3.13. Error

Name Schema

code
optional

string

details
optional

object

3.14. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.15. LineAssetsResource

Name Schema

line
optional

< Resource«AssetInfo» > array

links
optional

< Link > array

3.16. LineDistributionResponseResource

Name Schema

assetMetrics
optional

< AssetMetricData > array

downtimeCategories
optional

< DowntimeCategory > array

eventEndTime
optional

string

eventEpochEndTime
optional

integer (int64)

eventEpochStartTime
optional

integer (int64)

eventStartTime
optional

string

lineDowntimeByReasons
optional

< LineDowntimeData > array

links
optional

< Link > array

3.17. LineDowntimeData

Name Schema

category
optional

string

crewDesc
optional

string

detailId
optional

integer (int32)

duration
optional

number (float)

endTime
optional

string

fault
optional

string

location
optional

string

reason1
optional

string

reason2
optional

string

reason3
optional

string

reason4
optional

string

shiftDesc
optional

string

startTime
optional

string

unit
optional

string

unitId
optional

integer (int32)

3.18. LineOeeDataset

Name Description Schema

availableRate
optional

The available rate of this equipment data set

number (float)

line
optional

The line description of this equipment data set

string

lineId
optional

The line id of this equipment data set

integer (int32)

lineStatus
optional

The line status of this equipment data set

integer (int32)

percentOee
optional

The percent order equipment efficiency of this equipment data set

number (float)

performanceRate
optional

The performance rate of this equipment data set

number (float)

qualityRate
optional

The quality rate of this equipment data set

number (float)

unitDesc
optional

The unit description of this equipment data set

string

unitId
optional

The unit id of this equipment data set

string

3.19. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.20. OeeDetailedTrackInfo

Name Schema

availabilityInfo
optional

OeeTrackInfo

qualityInfo
optional

OeeTrackInfo

speedInfo
optional

OeeTrackInfo

3.21. OeeGrouping

Name Description Schema

data
optional

The oee details list of this oee grouping

< OverallOeeDetails > array

groupName
optional

The title of this oee grouping

string

3.22. OeeModeInfoResource

Name Schema

availableRate
optional

string

links
optional

< Link > array

oeeMode
optional

string

percentOee
optional

string

performanceRate
optional

string

qualityRate
optional

string

3.23. OeeSummaryResource

Name Schema

links
optional

< Link > array

oeeSummarySet
optional

< LineOeeDataset > array

3.24. OeeTrackInfo

Name Schema

actual
optional

number (float)

lost
optional

number (float)

planned
optional

number (float)

3.25. OverallOeeDetails

Name Description Schema

AvailableRate
optional

The available rate of this overall OEE details

string

DeptId
optional

The department id of this overall OEE details

integer (int32)

Id
optional

The unit id of this overall OEE details

string

LineId
optional

The line id of this overall OEE details

integer (int32)

Name
optional

The name of this overall OEE details

string

PathId
optional

The path id of this overall OEE details

integer (int32)

PercentOee
optional

The percent oee of this overall OEE details

string

PerformanceRate
optional

The performance rate id of this overall OEE details

string

QualityRate
optional

The quality rate of this overall OEE details

string

Status
optional

The status of this overall OEE details

string

groupIdentifier
optional

The group identifiers of this overall OEE details

string

oeeDetailedTrackInfo
optional

The oee deataied track information of this overall OEE details

OeeDetailedTrackInfo

oeeMode
optional

The oee mode of this overall OEE details

string

uom
optional

The unit of measure of this overall OEE details

string

3.26. OverallUnitOEEResource

Name Schema

kpi
optional

< OverallOeeDetails > array

links
optional

< Link > array

3.27. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.28. PerformanceCategoryDistribution

Name Schema

events
optional

integer (int32)

name
optional

string

totalTime
optional

number (float)

3.29. PerformanceCategoryResource

Name Schema

categoryByDuration
optional

< PerformanceCategoryDistribution > array

categoryByEvent
optional

< PerformanceCategoryDistribution > array

3.30. PerformanceDistribution

Name Description Schema

efficiencyStatistics
optional

The efficiency statistics of this performance distribution

number (float)

events
optional

The events of this performance distribution

integer (int32)

faultPercent
optional

The fault percent of this performance distribution

number (float)

mtbf
optional

The mean time before failure of this performance distribution

string

mttr
optional

The mean time to repair of this performance distribution

string

name
optional

The name of this performance distribution

string

performanceLoss
optional

The performance loss of this performance distribution

number (float)

rateLoss
optional

The rate loss of this performance distribution

number (float)

resultSetId
optional

The result set id of this performance distribution record

integer (int32)

totalPercent
optional

The total percent of this performance distribution

number (float)

totalTime
optional

The total time of this performance distribution

number (float)

3.31. PerformanceSummaryResource

Name Schema

links
optional

< Link > array

reason1
optional

< PerformanceDistribution > array

3.32. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.33. ProdTrackInfo

Name Schema

actual
optional

string

delivered
optional

string

planned
optional

string

3.34. ProductOrderOeeResource

Name Schema

links
optional

< Link > array

oeeDetails
optional

< Resource«OeeGrouping» > array

3.35. ProductionDetailedInfo

Name Schema

productionInfo
optional

ProductionInfo

trackInfo
optional

ProductionTrackInfo

3.36. ProductionInfo

Name Schema

description
optional

string

line
optional

string

path
optional

string

processOrder
optional

string

processOrderControlType
optional

string

processOrderStatus
optional

string

processOrderType
optional

string

productCode
optional

string

unit
optional

string

3.37. ProductionStatus

Name Schema

completePercentage
optional

number (float)

endTime
optional

string

order
optional

string

product
optional

string

productionDetailedInfo
optional

ProductionDetailedInfo

startTime
optional

string

status
optional

string

3.38. ProductionStatusResponseResource

Name Schema

links
optional

< Link > array

status
optional

< ProductionStatusSummary > array

3.39. ProductionStatusSummary

Name Schema

greaterThan
optional

boolean

groupName
optional

string

productionInfo
optional

< ProductionStatus > array

3.40. ProductionTrackInfo

Name Schema

quantityInfo
optional

ProdTrackInfo

schedulerInfo
optional

ProdTrackInfo

3.41. QualityCategoryResource

Name Schema

categoryByDuration
optional

< QualityDistribution > array

categoryByEvent
optional

< QualityDistribution > array

links
optional

< Link > array

reason1
optional

< QualityDistribution > array

reason1ByDuration
optional

< QualityDistribution > array

reason1ByEvent
optional

< QualityDistribution > array

3.42. QualityDistribution

Name Description Schema

events
optional

The events of this quality distribution

integer (int32)

mabe
optional

The mean amount produced between waste events. MABE replaces MTBF for waste events.

string

mape
optional

The mean amount of waste per event. MAPE replaces MTTR for waste events

string

name
optional

The name of this quality distribution

string

productionPercent
optional

The production percent of this quality distribution

number (float)

qualityPercent
optional

The quality percent of this quality distribution

number (float)

resultSetId
optional

The result set id of this quality distribution

integer (int32)

totalProduction
optional

The total production of this quality distribution

number (float)

totalTime
optional

The total time of this quality distribution

number (float)

3.43. QualitySummary

Name Schema

categoryByDuration
optional

< QualityDistribution > array

categoryByEvent
optional

< QualityDistribution > array

reason1
optional

< QualityDistribution > array

reason1ByDuration
optional

< QualityDistribution > array

reason1ByEvent
optional

< QualityDistribution > array

3.44. QualitySummaryDetailResource

Name Description Schema

categories
optional

Response as got from api production-metrics-viewer/quality/categories

QualitySummary

links
optional

< Link > array

mapeMabe
optional

Response as got from api production-metrics-viewer/quality/mape-mabe

QualitySummary

reasons
optional

Response as got from api production-metrics-viewer/quality/reasons

QualitySummary

3.45. QualitySummaryResource

Name Schema

categoryByDuration
optional

< QualityDistribution > array

categoryByEvent
optional

< QualityDistribution > array

links
optional

< Link > array

reason1
optional

< QualityDistribution > array

reason1ByDuration
optional

< QualityDistribution > array

reason1ByEvent
optional

< QualityDistribution > array

3.46. Resource«AssetInfo»

Name Schema

assetId
optional

integer (int64)

assetType
optional

string

identifier
optional

integer (int64)

links
optional

< Link > array

name
optional

string

3.47. Resource«AssetMetricData»

Name Schema

availableRate
optional

number (double)

line
optional

string

lineAssets
optional

< AssetInfo > array

lineId
optional

integer (int32)

links
optional

< Link > array

oeeMode
optional

integer (int32)

percentOEE
optional

number (double)

performanceRate
optional

number (double)

qualityRate
optional

number (double)

unitDesc
optional

string

unitId
optional

integer (int32)

unitsCount
optional

integer (int32)

3.48. Resource«OeeGrouping»

Name Description Schema

data
optional

The oee details list of this oee grouping

< OverallOeeDetails > array

groupName
optional

The title of this oee grouping

string

links
optional

< Link > array

3.49. S88RShiftsResource

Name Description Schema

links
optional

< Link > array

shiftDesc
optional

The list of shifts of type S88R shifts

< string > array

3.50. TimeSelectionResource

Name Description Schema

endTime
optional

End time in ISO-8601 format

string

eventEpochEndTime
optional

The end time in epoch second format

integer (int64)

eventEpochStartTime
optional

The start time in epoch second format

integer (int64)

links
optional

< Link > array

startTime
optional

Start time in ISO-8601 format

string

3.51. UnitAssetsResource

Name Schema

links
optional

< Link > array

units
optional

< Resource«AssetInfo» > array

3.52. UnitMetricsDataResponseResource

Name Schema

endTime
optional

string

links
optional

< Link > array

oeeMaxLmtOverride
optional

boolean

startTime
optional

string

statistics
optional

< UnitStatisticsData > array

uomList
optional

< UnitOfMeasure > array

3.53. UnitOfMeasure

Name Description Schema

puDesc
optional

The unit description of the products.

string

puId
optional

The unit id of the products.

integer (int32)

uom
optional

List of unit of measurement details of the products.

string

3.54. UnitStatisticsData

Name Schema

idealProduction
optional

number (float)

netProduction
optional

number (float)

partName
optional

string

productionAmount
optional

number (float)

qualityRate
optional

number (float)

wastedAmount
optional

number (float)

3.55. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} }
Example : {
"AppKey1" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey2" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey3" : {
"property1" : { },
"property2" : { },
"property3" : { }
}
}

object

viewName
optional

string

3.56. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://localhost:8443/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.