1. Overview
The service contains a collection of endpoints 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.2. Tags
-
availability-metrics-controller : Availability Metrics Controller
-
common-plant-controller : Common Plant Controller
-
common-plant-controller-v-2 : Common Plant Controller V 2
-
kpi-controller : KPI Controller
-
order-oee-controller : Order Oee Controller
-
overall-oee-controller : Overall Oee Controller
-
performance-metrics-controller : Performance Metrics Controller
-
product-oee-controller : Product Oee Controller
-
production-tracking-controller : Production Tracking Controller
-
quality-metrics-controller : Quality Metrics Controller
2. Resources
2.1. Availability-metrics-controller
Availability Metrics Controller
2.1.1. Fetches the list of all downtime categories for the specified units and the selected time range.
GET /production-metrics/v1/availability/categories
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
oeeParameter |
Define the type of downtime whether it is Availability, Performance or Quality, required in case of unit’s OEE mode is time based. |
enum (Availability, Performance, Quality) |
|
Query |
showTopNBars |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int64) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int64) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Comma separated unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Resource«AvailabilityDistribution» > array |
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.2. Fetches downtime distributions by locations, faults, reasons, products, crews and shifts for the specified units and selected time range.
GET /production-metrics/v1/availability/distribution
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
oeeParameter |
Define the type of downtime whether it is Availability, Performance or Quality, required in case of unit’s OEE mode is time based. |
enum (Availability, Performance, Quality) |
|
Query |
showTopNBars |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int64) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int64) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Semicolon separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.3. Fetches the list of all downtime categories for the specified line and the selected time range.
GET /production-metrics/v1/availability/metrics/downtime/lines/{lineId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
lineId |
lineId |
integer (int32) |
|
Query |
ascDesc |
0 for ascending order and 1 for descending order. This order will be applied on retrieved record. |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
excludeProductInfo |
Exclude product info in the response |
boolean |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
machineId |
Semicolon separated list of unit ids |
string |
|
Query |
oeeParameter |
Define the type of downtime whether it is Availability, Performance or Quality, required in case of unit’s OEE mode is time based. |
enum (Availability, Performance, Quality) |
|
Query |
pageNum |
Results page number to retrieve |
integer (int32) |
|
Query |
pageSize |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.4. Fetches downtime metrics for the specified unit and the selected time range.
GET /production-metrics/v1/availability/metrics/machines/{machineId}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
machineId |
unitId |
string |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
excludeProductInfo |
Exclude product info in the response |
boolean |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
metricName |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
string |
|
Query |
oeeParameter |
Define the type of downtime whether it is Availability, Performance or Quality, required in case of unit’s OEE mode is time based. |
enum (Availability, Performance, Quality) |
|
Query |
pageNum |
Results page number to retrieve |
integer (int32) |
|
Query |
pageSize |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
sortBy |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.1.5. Fetches the mean time to repair and mean time between failures.
GET /production-metrics/v1/availability/mttr-mtbf
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
Query |
lineId |
lineId |
integer (int32) |
Query |
oeeParameter |
Define the type of downtime whether it is Availability, Performance or Quality, required in case of unit’s OEE mode is time based. |
enum (Availability, Performance, Quality) |
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
timeSelection |
Time selection values |
integer (int32) |
Query |
unitList |
Semicolon separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.2. Common-plant-controller
Common Plant Controller
2.2.1. Fetches all the crews configured for this plant.
GET /production-metrics/v1/crews
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.2.2. Get all the shifts configured for this plant
GET /production-metrics/v1/shifts
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.2.3. Fetches the time details for the specified unit and timeSelection.
GET /production-metrics/v1/time-selection
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
equipmentId |
Comma seperated unitIds for equipmentType = 1, lineIds for equipmentType = 2 and departmentIds for equipmentType = 3. |
< string > array(multi) |
Query |
equipmentType |
Type of the equipment - 1 for Units, 2 for Lines, 3 for Departments. |
integer (int32) |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.3. Common-plant-controller-v-2
Common Plant Controller V 2
2.3.1. Fetches all the crews configured for this plant.
GET /production-metrics/v2/crews
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.3.2. Get all the shifts configured for this plant
GET /production-metrics/v2/shifts
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.3.3. Fetches the time details for the specified unit and timeSelection.
GET /production-metrics/v2/time-selection
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
equipmentId |
Comma seperated unitIds for equipmentType = 1, lineIds for equipmentType = 2 and departmentIds for equipmentType = 3. |
< string > array(multi) |
Query |
equipmentType |
Type of the equipment - 1 for Units, 2 for Lines, 3 for Departments. |
integer (int32) |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
No Content |
500 |
Internal Server Error |
No Content |
2.4. Kpi-controller
KPI Controller
2.4.1. Fetches the key performance indicators for the specified unit and the selected time range.
GET /production-metrics/v1
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ascDesc |
0 for ascending order and 1 for descending order. This order will be applied on retrieved record. |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
equipmentType |
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 |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
filterType |
0 for no filter, 1 to filter by ClockedOn units, 2 to filter by ClockedOff Units, 3 to filter by Running Unit and 4 to filter by Down unit. |
integer (int32) |
|
Query |
pageNum |
Results page number to retrieve |
integer (int32) |
|
Query |
pageSize |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
resultType |
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) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
summarize |
Set to 1 if summarized data is required for lines to whom specified units belong to, Not required in case of equipmentType is Unit. |
integer (int32) |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
List of Comma separated list of unit ids |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Resource«UnitOEEData» > array |
204 |
No Contant, No Kpi data available for given parameters. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.2. Fetches the unit counts for a given line Ids.
GET /production-metrics/v1/lines/unit-counts
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Resource«LineUnitCount» > array |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.3. Fetches the product quality metrics on the Unit for the selected time range.
GET /production-metrics/v1/machines/{machineId}/parts
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
machineId |
unitId |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
pageNum |
Results page number to retrieve |
integer (int32) |
|
Query |
pageSize |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.4. Fetches Unit of Measure for all products processed by the unit.
GET /production-metrics/v1/machines/{machineId}/uom
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< UnitOfMeasure > array |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.4.5. Fetches the key performance indicators for the specified unit and the selected time range.
GET /production-metrics/v2
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ascDesc |
0 for ascending order and 1 for descending order. This order will be applied on retrieved record. |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
equipmentType |
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 |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
filterType |
0 for no filter, 1 to filter by ClockedOn units, 2 to filter by ClockedOff Units, 3 to filter by Running Unit and 4 to filter by Down unit. |
integer (int32) |
|
Query |
pageNum |
Results page number to retrieve |
integer (int32) |
|
Query |
pageSize |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
resultType |
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) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int32) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
summarize |
Set to 1 if summarized data is required for lines to whom specified units belong to, Not required in case of equipmentType is Unit. |
integer (int32) |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
List of Comma separated list of unit ids |
< string > array(multi) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Contant, No Kpi data available for given parameters. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.5. Order-oee-controller
Order Oee Controller
2.5.1. Fetches the process order OEE details by shifts, crew and path for the specified units and selected time range.
GET /production-metrics/v1/oee/order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
equipmentList |
Comma separated unit ids |
string |
Query |
equipmentType |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int32) |
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
Query |
groupBy |
1 for No grouping, 2 for group by Shift , 3 for group by Crew , 4 for group by Path. |
integer (int32) |
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Resource«OeeGrouping» > array |
204 |
No Contant. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.6. Overall-oee-controller
Overall Oee Controller
2.6.1. Fetches the unit’s OEE summary for the specified units and selected time range.
GET /production-metrics/v1/machines/oee/summary
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
equipmentId |
Comma separated unit ids |
string |
|
Query |
equipmentType |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int32) |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
summarize |
Set to 1 if only combined OEE Summary of specified units is required. |
enum (0, 1) |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Contant, No Overall Efficiency Indicator found for given parameters. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.6.2. Fetches the overall equipment efficiency mode the specified line.
GET /production-metrics/v1/oee/mode
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
lineId |
Id of the line of whose OEE mode is required. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
204 |
No Contant, No Overall equipment efficiency found for the given line Id. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.6.3. Fetches the overall KPIs for the specified lines and selected time range.
GET /production-metrics/v1/oee/summary
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
ascdesc |
0 for ascending order and 1 for descending order. This order will be applied on retrieved record. |
integer (int32) |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
equipmentType |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int32) |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
maxresultsret |
Maximum nuber of results required. |
integer (int32) |
|
Query |
sortorder |
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) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
summarize |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Comma separated unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< LineOeeDataset > array |
204 |
No Contant, No Key Performance Indicators found for given parameters. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.7. Performance-metrics-controller
Performance Metrics Controller
2.7.1. Fetches performance category distribution for the specified units and selected time range.
GET /production-metrics/v1/performance/categories
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
showTopNBars |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int64) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int64) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Semicolon separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Resource«PerformanceDistribution» > array |
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.7.2. Fetches performance distributions by locations, faults, reasons, products, crews and shifts for the specified units and selected time range.
GET /production-metrics/v1/performance/distribution
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
showTopNBars |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int64) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int64) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Semicolon separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.8. Product-oee-controller
Product Oee Controller
2.8.1. Fetches the product’s OEE details by shifts, crew and path for the specified units and selected time range.
GET /production-metrics/v1/oee/product
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
equipmentList |
Comma separated unit ids |
string |
Query |
equipmentType |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int32) |
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
Query |
groupBy |
1 for No grouping, 2 for group by Shift , 3 for group by Crew , 4 for group by Path. |
integer (int32) |
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< Resource«OeeGrouping» > array |
204 |
No Contant. |
No Content |
400 |
Bad Request. |
No Content |
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.9. Production-tracking-controller
Production Tracking Controller
2.9.1. Fetches the list of production orders by specified equipment ids and selected time range.
GET /production-metrics/v1/production-status
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
equipmentList |
Comma seperated unitIds for equipmentType = 1, lineIds for equipmentType = 2 and departmentIds for equipmentType = 3. |
string |
Query |
equipmentType |
Type of the equipment - 1 for Units, 2 for Lines, 3 for Departments. |
integer (int32) |
Query |
groupBy |
1 for No grouping, 2 for group by Shift , 3 for group by Crew , 4 for group by Path. |
integer (int32) |
Query |
pageNum |
Results page number to retrieve |
string |
Query |
pageSize |
Number of records per page, from 1 to 500 |
string |
Query |
pathList |
comma or semicolon separated path list |
string |
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
Query |
timeSelection |
Time selection values |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Resource«ProductionTracking» > array |
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
2.10. Quality-metrics-controller
Quality Metrics Controller
2.10.1. Fetches quality distributions by locations, faults, reasons, products, crews and shifts for the specified units and selected time range.
GET /production-metrics/v1/quality/distribution
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
calculateOtherQualityDistribution |
Optional flag whether to calculate Product Quality Distribution details, Crew Quality distribution details property returned by this api. By default this is true and if set false those properties would be null |
boolean |
|
Query |
endTime |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
filterNpt |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
showTopNBars |
Please leave this field blank, This parameter is not being used. It will be deprecated later. |
integer (int64) |
|
Query |
sortOrder |
1 for Sort by PerformanceRate, 2 for Sort by QualityRate, 3 for sort by AvailableRate and 4 for sort by UnitDescription |
integer (int64) |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string |
|
Query |
timeSelection |
Time selection values |
integer (int32) |
|
Query |
unitList |
Semicolon separated list of unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
No Content |
400 |
Bad Request |
|
401 |
Unauthorized |
No Content |
500 |
Internal Server Error |
No Content |
3. Definitions
3.1. AvailabilityDistribution
| Name | Description | Schema |
|---|---|---|
events |
The events data of this availability distribution |
integer (int32) |
faults |
The faults data of this availability distribution |
string |
mtbf |
The mean time between failure of this availability distribution |
string |
mttr |
The mean time to repair of this availability distribution in hh:mm:ss format |
string |
name |
The Level name of this availability distribution |
string |
quality |
The quality data of this availability distribution |
string |
totalTime |
The total time duration for this availability distribution |
number (float) |
3.2. AvailabilityDistributionSummary
| Name | Description | Schema |
|---|---|---|
crew |
The crew details of this availability distribution summary |
< AvailabilityDistribution > array |
fault |
The faults of this availability distribution summary |
< AvailabilityDistribution > array |
location |
The locations of this availability distribution summary |
< AvailabilityDistribution > array |
product |
The products for this availability distributio summaryn |
< AvailabilityDistribution > array |
reason1 |
The reason one for this availability distribution summary |
< AvailabilityDistribution > array |
reason2 |
The reason two for this availability distribution summary |
< AvailabilityDistribution > array |
reason3 |
The reason three for this availability distribution summary |
< AvailabilityDistribution > array |
reason4 |
The reason four for this availability distribution summary |
< AvailabilityDistribution > array |
shift |
The shift details of this availability distribution summary |
< AvailabilityDistribution > array |
3.3. Crews
| Name | Description | Schema |
|---|---|---|
crewDesc |
The list of Crew, when the downtime occurred |
< string > array |
3.4. DownTimeResponse
| Name | Description | Schema |
|---|---|---|
action1 |
The level one action taken to rectify this downtime |
string |
action2 |
The level two action taken to rectify this downtime |
string |
action3 |
The level three action taken to rectify this downtime |
string |
action4 |
The level four action taken to rectify this downtime |
string |
category |
The category of this downtime |
string |
crewDesc |
The crew description of this downtime |
string |
detailId |
The Detail Id of this downtime |
integer (int32) |
duration |
The total duration for this downtime |
number (float) |
endTime |
The end time for this downtime |
string |
fault |
The fault of this downtime |
string |
firstCommentId |
The id of the first comment on this downtime |
string |
isNonProductive |
Indicator if this downtime is non productive |
integer (int32) |
lastCommentId |
The id of the last comment on this downtime |
string |
location |
The location where this downtime happend |
string |
nPTCategory |
The non productive time category of this downtime |
string |
pathCode |
The path code of this downtime |
string |
processOrder |
The process order this unit was handling during this downtime |
string |
productCode |
Code for the product this unit was handling during this downtime |
string |
reason1 |
The level one reason for this downtime |
string |
reason2 |
The level two reason for this downtime |
string |
reason3 |
The level three reason for this downtime |
string |
reason4 |
The level four reason for this downtime |
string |
shiftDesc |
The shift description of this downtime |
string |
startTime |
The start time for this downtime |
string |
status |
The status of this downtime |
string |
unit |
The unit where this downtime happend |
string |
unitId |
The unit ID where this downtime happend |
integer (int32) |
uptime |
The uptime of this downtime |
number (float) |
3.5. DowntimeDistribution
| Name | Schema |
|---|---|
events |
integer (int32) |
faults |
string |
id |
string |
mtbf |
string |
mttr |
string |
name |
string |
quality |
string |
resultSetId |
integer (int32) |
totalTime |
number (float) |
3.6. DowntimeReason
| Name | Description | Schema |
|---|---|---|
range |
The list of time range of this Downtime Reason |
< TimeRange > array |
reasonName |
The reason name of this Downtime Reason |
string |
totalTime |
The total time of this Downtime Reason |
string |
3.8. LineDowntimeReasonResponse
| Name | Description | Schema |
|---|---|---|
categoryByDuration |
The category Duration List of this Downtime Reason Response |
< DowntimeDistribution > array |
categoryByEvents |
The category by events List of this Downtime Reason Response |
< DowntimeDistribution > array |
downtime_by_reason |
The list of downtime details for the units under this line |
< DownTimeResponse > array |
eventEndTime |
The end time of this Downtime Reason Response |
string |
eventEpochEndTime |
The end time in epoch format of this Downtime Reason Response |
integer (int64) |
eventEpochStartTime |
The start time in epoch format of this Downtime Reason Response |
integer (int64) |
eventStartTime |
The start time of this Downtime Reason Response |
string |
unitOEEDataList |
The list of OEE data for the units under this line |
< UnitOEEData > array |
3.9. LineOeeDataset
| Name | Description | Schema |
|---|---|---|
availableRate |
The available rate of this equipment data set |
number (float) |
line |
The line description of this equipment data set |
string |
lineId |
The line id of this equipment data set |
integer (int32) |
lineStatus |
The line status of this equipment data set |
integer (int32) |
percentOee |
The percent order equipment efficiency of this equipment data set |
number (float) |
performanceRate |
The performance rate of this equipment data set |
number (float) |
qualityRate |
The quality rate of this equipment data set |
number (float) |
unitDesc |
The unit description of this equipment data set |
string |
unitId |
The unit id of this equipment data set |
string |
3.10. LineUnitCount
| Name | Description | Schema |
|---|---|---|
lineId |
The lineId of which unit id belongs to. |
integer (int32) |
unitCount |
The number of units configured. |
integer (int32) |
3.12. OEEResponse
| Name | Schema |
|---|---|
pageNumber |
integer (int32) |
pageSize |
integer (int32) |
remainingPages |
integer (int32) |
unitOEEData |
< UnitOEEData > array |
3.13. OeeDetailedTrackInfo
| Name | Schema |
|---|---|
availabilityInfo |
|
qualityInfo |
|
speedInfo |
3.14. OeeGrouping
| Name | Description | Schema |
|---|---|---|
data |
The oee details list of this oee grouping |
< OverallOeeDetails > array |
groupName |
The title of this oee grouping |
string |
3.15. OeeTrackInfo
| Name | Schema |
|---|---|
actual |
number (float) |
lost |
number (float) |
planned |
number (float) |
3.16. OverallOeeDetails
| Name | Description | Schema |
|---|---|---|
AvailableRate |
The available rate of this overall OEE details |
string |
DeptId |
The department id of this overall OEE details |
integer (int32) |
Id |
The unit id of this overall OEE details |
string |
LineId |
The line id of this overall OEE details |
integer (int32) |
Name |
The name of this overall OEE details |
string |
PathId |
The path id of this overall OEE details |
integer (int32) |
PercentOee |
The percent oee of this overall OEE details |
string |
PerformanceRate |
The performance rate id of this overall OEE details |
string |
QualityRate |
The quality rate of this overall OEE details |
string |
Status |
The status of this overall OEE details |
string |
groupIdentifier |
The group identifiers of this overall OEE details |
string |
oeeDetailedTrackInfo |
The oee deataied track information of this overall OEE details |
|
oeeMode |
The oee mode of this overall OEE details |
string |
uom |
The unit of measure of this overall OEE details |
string |
3.17. OverallOeeTotals
| Name | Description | Schema |
|---|---|---|
KPI |
The overall key perfprmance indicators of this overall oee totals |
< OverallOeeDetails > array |
3.18. PerformanceDistribution
| Name | Description | Schema |
|---|---|---|
efficiencyStatistics |
The efficiency statistics of this performance distribution |
number (float) |
events |
The events of this performance distribution |
integer (int32) |
faultPercent |
The fault percent of this performance distribution |
number (float) |
mtbf |
The mean time before failure of this performance distribution |
string |
mttr |
The mean time to repair of this performance distribution |
string |
name |
The name of this performance distribution |
string |
performanceLoss |
The performance loss of this performance distribution |
number (float) |
rateLoss |
The rate loss of this performance distribution |
number (float) |
resultSetId |
The result set id of this performance distribution record |
integer (int32) |
totalPercent |
The total percent of this performance distribution |
number (float) |
totalTime |
The total time of this performance distribution |
number (float) |
3.19. PerformanceDistributionSummary
| Name | Description | Schema |
|---|---|---|
crew |
The location of performance distribution summery |
< PerformanceDistribution > array |
fault |
The fault of performance distribution summery |
< PerformanceDistribution > array |
location |
The location of performance distribution summery |
< PerformanceDistribution > array |
product |
The location of performance distribution summery |
< PerformanceDistribution > array |
reason1 |
The first reason of performance distribution summery |
< PerformanceDistribution > array |
reason2 |
The second reason of performance distribution summery |
< PerformanceDistribution > array |
reason3 |
The third reason of performance distribution summery |
< PerformanceDistribution > array |
reason4 |
The fourth reason of performance distribution summery |
< PerformanceDistribution > array |
shift |
The location of performance distribution summery |
< PerformanceDistribution > array |
3.20. ProdTrackInfo
| Name | Schema |
|---|---|
actual |
string |
delivered |
string |
planned |
string |
3.22. ProductionDetails
| Name | Schema |
|---|---|
completePercentage |
number (float) |
endTime |
string |
order |
string |
product |
string |
productionDetailedInfo |
|
startTime |
string |
status |
string |
3.23. ProductionInfo
| Name | Schema |
|---|---|
description |
string |
line |
string |
path |
string |
processOrder |
string |
processOrderControlType |
string |
processOrderStatus |
string |
processOrderType |
string |
productCode |
string |
unit |
string |
3.25. ProductionTracking
| Name | Description | Schema |
|---|---|---|
greaterThan |
boolean |
|
groupName |
The group name of this production tracking |
string |
productionInfo |
The production information list of this production tracking |
< ProductionDetails > array |
3.26. QualityDistribution
| Name | Description | Schema |
|---|---|---|
events |
The events of this quality distribution |
integer (int32) |
mabe |
The mean amount produced between waste events. MABE replaces MTBF for waste events. |
string |
mape |
The mean amount of waste per event. MAPE replaces MTTR for waste events |
string |
name |
The name of this quality distribution |
string |
productionPercent |
The production percent of this quality distribution |
number (float) |
qualityPercent |
The quality percent of this quality distribution |
number (float) |
resultSetId |
The result set id of this quality distribution |
integer (int32) |
totalProduction |
The total production of this quality distribution |
number (float) |
totalTime |
The total time of this quality distribution |
number (float) |
3.27. QualityDistributionSummary
| Name | Description | Schema |
|---|---|---|
crew |
The creaw of quality distribution summary |
< QualityDistribution > array |
fault |
The fault description of quality distribution summary |
< QualityDistribution > array |
location |
The location description of quality distribution summary |
< QualityDistribution > array |
product |
The product of quality distribution summary |
< QualityDistribution > array |
reason1 |
The first reason description of quality distribution summary |
< QualityDistribution > array |
reason2 |
The location second reason of quality distribution summary |
< QualityDistribution > array |
reason3 |
The location third reason of quality distribution summary |
< QualityDistribution > array |
reason4 |
The location fourth reason of quality distribution summary |
< QualityDistribution > array |
shift |
The shift of quality distribution summary |
< QualityDistribution > array |
3.28. Resource«AvailabilityDistributionSummary»
| Name | Description | Schema |
|---|---|---|
crew |
The crew details of this availability distribution summary |
< AvailabilityDistribution > array |
fault |
The faults of this availability distribution summary |
< AvailabilityDistribution > array |
links |
< Link > array |
|
location |
The locations of this availability distribution summary |
< AvailabilityDistribution > array |
product |
The products for this availability distributio summaryn |
< AvailabilityDistribution > array |
reason1 |
The reason one for this availability distribution summary |
< AvailabilityDistribution > array |
reason2 |
The reason two for this availability distribution summary |
< AvailabilityDistribution > array |
reason3 |
The reason three for this availability distribution summary |
< AvailabilityDistribution > array |
reason4 |
The reason four for this availability distribution summary |
< AvailabilityDistribution > array |
shift |
The shift details of this availability distribution summary |
< AvailabilityDistribution > array |
3.29. Resource«AvailabilityDistribution»
| Name | Description | Schema |
|---|---|---|
events |
The events data of this availability distribution |
integer (int32) |
faults |
The faults data of this availability distribution |
string |
links |
< Link > array |
|
mtbf |
The mean time between failure of this availability distribution |
string |
mttr |
The mean time to repair of this availability distribution in hh:mm:ss format |
string |
name |
The Level name of this availability distribution |
string |
quality |
The quality data of this availability distribution |
string |
totalTime |
The total time duration for this availability distribution |
number (float) |
3.30. Resource«Crews»
| Name | Description | Schema |
|---|---|---|
crewDesc |
The list of Crew, when the downtime occurred |
< string > array |
links |
< Link > array |
3.31. Resource«LineUnitCount»
| Name | Description | Schema |
|---|---|---|
lineId |
The lineId of which unit id belongs to. |
integer (int32) |
links |
< Link > array |
|
unitCount |
The number of units configured. |
integer (int32) |
3.32. Resource«OeeGrouping»
| Name | Description | Schema |
|---|---|---|
data |
The oee details list of this oee grouping |
< OverallOeeDetails > array |
groupName |
The title of this oee grouping |
string |
links |
< Link > array |
3.33. Resource«PerformanceDistributionSummary»
| Name | Description | Schema |
|---|---|---|
crew |
The location of performance distribution summery |
< PerformanceDistribution > array |
fault |
The fault of performance distribution summery |
< PerformanceDistribution > array |
links |
< Link > array |
|
location |
The location of performance distribution summery |
< PerformanceDistribution > array |
product |
The location of performance distribution summery |
< PerformanceDistribution > array |
reason1 |
The first reason of performance distribution summery |
< PerformanceDistribution > array |
reason2 |
The second reason of performance distribution summery |
< PerformanceDistribution > array |
reason3 |
The third reason of performance distribution summery |
< PerformanceDistribution > array |
reason4 |
The fourth reason of performance distribution summery |
< PerformanceDistribution > array |
shift |
The location of performance distribution summery |
< PerformanceDistribution > array |
3.34. Resource«PerformanceDistribution»
| Name | Description | Schema |
|---|---|---|
efficiencyStatistics |
The efficiency statistics of this performance distribution |
number (float) |
events |
The events of this performance distribution |
integer (int32) |
faultPercent |
The fault percent of this performance distribution |
number (float) |
links |
< Link > array |
|
mtbf |
The mean time before failure of this performance distribution |
string |
mttr |
The mean time to repair of this performance distribution |
string |
name |
The name of this performance distribution |
string |
performanceLoss |
The performance loss of this performance distribution |
number (float) |
rateLoss |
The rate loss of this performance distribution |
number (float) |
resultSetId |
The result set id of this performance distribution record |
integer (int32) |
totalPercent |
The total percent of this performance distribution |
number (float) |
totalTime |
The total time of this performance distribution |
number (float) |
3.35. Resource«ProductionTracking»
| Name | Description | Schema |
|---|---|---|
greaterThan |
boolean |
|
groupName |
The group name of this production tracking |
string |
links |
< Link > array |
|
productionInfo |
The production information list of this production tracking |
< ProductionDetails > array |
3.36. Resource«QualityDistributionSummary»
| Name | Description | Schema |
|---|---|---|
crew |
The creaw of quality distribution summary |
< QualityDistribution > array |
fault |
The fault description of quality distribution summary |
< QualityDistribution > array |
links |
< Link > array |
|
location |
The location description of quality distribution summary |
< QualityDistribution > array |
product |
The product of quality distribution summary |
< QualityDistribution > array |
reason1 |
The first reason description of quality distribution summary |
< QualityDistribution > array |
reason2 |
The location second reason of quality distribution summary |
< QualityDistribution > array |
reason3 |
The location third reason of quality distribution summary |
< QualityDistribution > array |
reason4 |
The location fourth reason of quality distribution summary |
< QualityDistribution > array |
shift |
The shift of quality distribution summary |
< QualityDistribution > array |
3.37. Resource«S88RShifts»
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
shiftDesc |
The list of shifts of type S88R shifts |
< string > array |
3.38. Resource«TimeSelectionV2»
| Name | Description | Schema |
|---|---|---|
endTime |
End time in ISO-8601 format |
string (date-time) |
eventEpochEndTime |
The end time in epoch second format |
integer (int64) |
eventEpochStartTime |
The start time in epoch second format |
integer (int64) |
links |
< Link > array |
|
startTime |
Start time in ISO-8601 format |
string (date-time) |
3.39. Resource«TimeSelection»
| Name | Description | Schema |
|---|---|---|
endTime |
End time in ISO-8601 format |
string |
eventEpochEndTime |
The end time in epoch second format |
integer (int64) |
eventEpochStartTime |
The start time in epoch second format |
integer (int64) |
links |
< Link > array |
|
startTime |
Start time in ISO-8601 format |
string |
3.40. Resource«UnitOEEData»
| Name | Description | Schema |
|---|---|---|
actualSpeed |
The actual speed of this unit |
number (float) |
availableRate |
The available Rate of this unit |
number (float) |
idealProductionAmount |
The ideal production amount of this unit |
number (float) |
idealSpeed |
The ideal speed of this unit |
number (float) |
line |
The line description this Unit OEE Data record belongs to |
string |
lineId |
The line ID of the unit this UnitOEEData record belongs to |
string |
links |
< Link > array |
|
loadingTime |
The loading time of this unit |
number (float) |
machineCount |
The macine count for this UnitOEEData |
integer (int32) |
oeeMode |
The OEE mode of this unit |
integer (int32) |
percentOee |
The percentage OEE of this unit |
number (float) |
performanceRate |
The performance rate of this unit |
number (float) |
performanceTime |
The performance time of this unit |
number (float) |
productionAmount |
The actual production amount of this unit |
number (float) |
qualityRate |
The quality rate of this unit |
number (float) |
runTime |
The run time of this unit |
number (float) |
unitDesc |
The unit description this UnitOEEData record belongs to |
string |
unitId |
The unit ID this UnitOEEData record belongs to |
string |
unitOrder |
The unit order of this UnitOEEData |
string |
wasteAmount |
The waste amount for this unit |
number (float) |
3.41. Resource«UnitStatisticsDataResponse»
| Name | Description | Schema |
|---|---|---|
endTime |
The end time of unit statistics |
string |
links |
< Link > array |
|
oeeMaxLmtOverride |
The value of OEE Max Limit Override site param |
boolean |
startTime |
The start time of unit statistics |
string |
statistics |
The List of related unit statistics. |
< UnitStatisticsData > array |
3.42. S88RShifts
| Name | Description | Schema |
|---|---|---|
shiftDesc |
The list of shifts of type S88R shifts |
< string > array |
3.43. TimeRange
| Name | Description | Schema |
|---|---|---|
category |
The category of this TimeRange |
string |
endTime |
The end time of this TimeRange |
string |
startTime |
The start time of this TimeRange |
string |
3.44. TimeSelection
| Name | Description | Schema |
|---|---|---|
endTime |
End time in ISO-8601 format |
string |
eventEpochEndTime |
The end time in epoch second format |
integer (int64) |
eventEpochStartTime |
The start time in epoch second format |
integer (int64) |
startTime |
Start time in ISO-8601 format |
string |
3.45. TimeSelectionV2
| Name | Description | Schema |
|---|---|---|
endTime |
End time in ISO-8601 format |
string (date-time) |
eventEpochEndTime |
The end time in epoch second format |
integer (int64) |
eventEpochStartTime |
The start time in epoch second format |
integer (int64) |
startTime |
Start time in ISO-8601 format |
string (date-time) |
3.46. UnitDowntimeReasonResponse
| Name | Description | Schema |
|---|---|---|
categoryByDuration |
The category Duration List of this Downtime Reason Response |
< DowntimeDistribution > array |
categoryByEvents |
The category by events List of this Downtime Reason Response |
< DowntimeDistribution > array |
downtimeByReason |
The list of downtime reason |
< DowntimeReason > array |
eventEndTime |
The end time of this Downtime Reason Response |
string |
eventEpochEndTime |
The end time in epoch format of this Downtime Reason Response |
integer (int64) |
eventEpochStartTime |
The start time in epoch format of this Downtime Reason Response |
integer (int64) |
eventStartTime |
The start time of this Downtime Reason Response |
string |
3.47. UnitOEEData
| Name | Description | Schema |
|---|---|---|
actualSpeed |
The actual speed of this unit |
number (float) |
availableRate |
The available Rate of this unit |
number (float) |
idealProductionAmount |
The ideal production amount of this unit |
number (float) |
idealSpeed |
The ideal speed of this unit |
number (float) |
line |
The line description this Unit OEE Data record belongs to |
string |
lineId |
The line ID of the unit this UnitOEEData record belongs to |
string |
loadingTime |
The loading time of this unit |
number (float) |
machineCount |
The macine count for this UnitOEEData |
integer (int32) |
oeeMode |
The OEE mode of this unit |
integer (int32) |
percentOee |
The percentage OEE of this unit |
number (float) |
performanceRate |
The performance rate of this unit |
number (float) |
performanceTime |
The performance time of this unit |
number (float) |
productionAmount |
The actual production amount of this unit |
number (float) |
qualityRate |
The quality rate of this unit |
number (float) |
runTime |
The run time of this unit |
number (float) |
unitDesc |
The unit description this UnitOEEData record belongs to |
string |
unitId |
The unit ID this UnitOEEData record belongs to |
string |
unitOrder |
The unit order of this UnitOEEData |
string |
wasteAmount |
The waste amount for this unit |
number (float) |
3.48. UnitOfMeasure
| Name | Description | Schema |
|---|---|---|
puDesc |
The unit description of the products. |
string |
puId |
The unit id of the products. |
integer (int32) |
uom |
List of unit of measurement details of the products. |
string |
3.49. UnitStatisticsData
| Name | Schema |
|---|---|
idealProduction |
number (float) |
netProduction |
number (float) |
partName |
string |
productionAmount |
number (float) |
qualityRate |
number (float) |
wastedAmount |
number (float) |
3.50. UnitStatisticsDataResponse
| Name | Description | Schema |
|---|---|---|
endTime |
The end time of unit statistics |
string |
oeeMaxLmtOverride |
The value of OEE Max Limit Override site param |
boolean |
startTime |
The start time of unit statistics |
string |
statistics |
The List of related unit statistics. |
< UnitStatisticsData > array |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://localhost:8443/uaa/oauth/authorize
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost:8443/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost:8443/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |