1. Overview
The MES service contains a collection of RESTful service calls to retrieve various information relevant to manufacturing execution.
Descriptions of these functions can be found in the section headers for each collection of relevant resources.
1.2. Tags
-
active-product-controller : Active Product Controller
-
color-scheme-field-controller : Color Scheme Field Controller
-
comment-controller : Comment Controller
-
department-controller : Department Controller
-
downtime-controller : Downtime Controller
-
downtime-statistics-controller : Downtime Statistics Controller
-
downtime-unit-controller : Downtime Unit Controller
-
fault-controller : Fault Controller
-
group-controller : Group Controller
-
line-controller : Line Controller
-
npt-controller : Npt Controller
-
path-controller : Path Controller
-
process-order-actuals-controller : Process Order Actuals Controller
-
process-order-controller : Process Order Controller
-
process-order-start-controller : Process Order Start Controller
-
product-controller : Product Controller
-
product-family-controller : Product Family Controller
-
product-group-controller : Product Group Controller
-
product-unit-controller : Product Unit Controller
-
production-ratio-controller : Production Ratio Controller
-
unit-controller : Unit Controller
-
unit-process-orders-controller : Unit Process Orders Controller
-
variable-category-controller : Variable Category Controller
-
variable-controller : Variable Controller
2. Resources
2.1. Active-product-controller
Active Product Controller
2.1.1. Get All Active Products Details
GET /production/v1/activeProducts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
Query |
lineId |
lineId |
< integer (int64) > array(multi) |
Query |
lineIds |
lineIds |
string |
Query |
startTime |
startTime |
string (date-time) |
Query |
unitId |
unitId |
< integer (int64) > array(multi) |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ActiveProductPage > array |
2.2. Color-scheme-field-controller
Color Scheme Field Controller
2.2.1. Get categories field colors
GET /color/v1/colorSchemeFields
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
colorSchemeCategory |
Color Scheme Category to retrieve the Color Scheme Fields. |
enum (AutologCellForeground, AutologCellBackground, Spreadsheet, Trendsheet, DelayReports, QualityReports, COAReports, OtherReports, ProficyWebCharts, Downtime, Waste) |
|
Query |
colorSchemeId |
Color Scheme Id to retrieve the Color Scheme Fields. |
integer (int64) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
2.3. Comment-controller
Comment Controller
2.3.1. Start a new comment thread
POST /comment/v1/commentThreads
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.create+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.create+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.3.2. Add a comment to a thread
POST /comment/v1/commentThreads/{threadId}/comments
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
threadId |
threadId |
integer (int64) |
Body |
newComment |
newComment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.create+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.create+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.3.3. Get comments by thread
GET /comment/v1/commentThreads/{threadId}/comments
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.3.4. Get a thread comment
GET /comment/v1/commentThreads/{threadId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
commentId |
integer (int64) |
Path |
threadId |
threadId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.3.5. Update a comment
PUT /comment/v1/commentThreads/{threadId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
commentId |
integer (int64) |
Path |
threadId |
threadId |
integer (int64) |
Body |
updatedComment |
updatedComment |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.update+json -
application/vnd.ge.mes.v1.update+json -
application/json;charset=UTF-8
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.3.6. Delete a comment
DELETE /comment/v1/commentThreads/{threadId}/comments/{commentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
commentId |
commentId |
integer (int64) |
Path |
threadId |
threadId |
integer (int64) |
Query |
commentType |
commentType |
enum (Tests, Variables, Product, ProductionEvent, SheetColumns, AlarmTemplates, AlarmTemplateVariableData, ProdUnits, UDE, UDECause, UDEAction, UDEResearch, AlarmCause, AlarmAction, AlarmResearch, DowntimeCause, DowntimeAction, DowntimeResearch, ProductChange, WasteCause, WasteAction, WasteResearch, EDModels, Calculations, EventSubtypes, EventConfiguration, CustomerOrders, CustomerOrderLineItems, EDFields, ProductionPlan, Characteristics, ProductionLines, ProductionGroups, SecurityGroups, Specifications, ProductionSetup, ProductionSetupDetail, CrewSchedule, ActiveSpecs, COA, COAItems, ContainerLocation, CustomerCOA, EventDetails, EventReasons, GB_DSet, GB_RSum, InProcessBins, PrdExecInputEvent, ProductFamily, ProductProperties, ProductionPlanStarts, ReportTreeTemplates, ReportWebpages, SavedQueries, Sheets, Shipment, ShipmentLineItems, StoredProcs, DowntimeSummaryAction, DowntimeSummaryCause, DowntimeSummaryResearch, TransProperties, TransVariables, Transactions, VarSpecs, DefectDetailsAction, DefectDetailsCause, DefectDetailsResearch, PrdExecPaths, UnitLocation, Departments, PrdExecPathUnitStarts, NonProductiveDetail, Activity) |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
422 |
Unprocessable Entity |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.4. Department-controller
Department Controller
2.4.1. Get departments
GET /s95/v1/departments
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Department > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.4.2. Get a department
GET /s95/v1/departments/{departmentId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
departmentId |
departmentId |
integer (int64) |
Query |
expandLines |
expandLines |
boolean |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.5. Downtime-controller
Downtime Controller
2.5.1. Create a downtime record
POST /downtime/v1/downtimeRecords
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.5.2. Get all downtime records
GET /downtime/v1/downtimeRecords
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
|
Query |
filterCategoryIds |
filterCategoryIds |
string |
|
Query |
filterLocationIds |
filterLocationIds |
string |
|
Query |
filterMaxDuration |
filterMaxDuration |
number (double) |
|
Query |
filterMinDuration |
filterMinDuration |
number (double) |
|
Query |
filterNptOnly |
filterNptOnly |
boolean |
|
Query |
filterStatusIds |
filterStatusIds |
string |
|
Query |
isMasterUnit |
isMasterUnit |
boolean |
|
Query |
lineIds |
lineIds |
string |
|
Query |
startTime |
startTime |
string (date-time) |
|
Query |
timeSelection |
timeSelection |
integer (int64) |
|
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.5.3. Split a downtime record
PATCH /downtime/v1/downtimeRecords
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Downtime > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.5.4. Get a downtime record
GET /downtime/v1/downtimeRecords/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.5.5. Update a downtime record
PUT /downtime/v1/downtimeRecords/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
id |
id |
integer (int64) |
|
Query |
mergeExistingRecords |
mergeExistingRecords |
boolean |
|
Body |
updatedDowntime |
updatedDowntime |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.5.6. Delete a downtime record
DELETE /downtime/v1/downtimeRecords/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.5.7. Get available edit times
GET /downtime/v1/downtimeRecords/{id}/availableEditTimes
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.6. Downtime-statistics-controller
Downtime Statistics Controller
2.6.1. Create all downtime records
GET /downtime/v1/downtimeStatistics
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
endTime |
endTime |
string (date-time) |
Query |
filterCategoryIds |
filterCategoryIds |
string |
Query |
filterLocationIds |
filterLocationIds |
string |
Query |
filterMaxDuration |
filterMaxDuration |
number (double) |
Query |
filterMinDuration |
filterMinDuration |
number (double) |
Query |
filterNptOnly |
filterNptOnly |
boolean |
Query |
filterStatusIds |
filterStatusIds |
string |
Query |
isMaster |
isMaster |
boolean |
Query |
lineIds |
lineIds |
string |
Query |
startTime |
startTime |
string (date-time) |
Query |
timeSelection |
timeSelection |
integer (int64) |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.7. Downtime-unit-controller
Downtime Unit Controller
2.7.1. Get all units
GET /downtime/v1/units
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
lineId |
lineId |
integer (int64) |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< BaseAsset > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.8. Fault-controller
Fault Controller
2.8.1. Get all faults
GET /downtime/v1/faults
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.9. Group-controller
Group Controller
2.9.1. Get groups
GET /s95/v1/groups
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
expandVariables |
expandVariables |
boolean |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Group > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.9.2. Get a group
GET /s95/v1/groups/{groupId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
groupId |
groupId |
integer (int64) |
Query |
expandVariables |
expandVariables |
boolean |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.10. Line-controller
Line Controller
2.10.1. Get all lines
GET /s95/v1/lines
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
departmentId |
departmentId |
integer (int64) |
Query |
expandUnits |
expandUnits |
boolean |
Query |
isRouteEnabled |
isRouteEnabled |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Line > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.10.2. Get a line
GET /s95/v1/lines/{lineId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
lineId |
lineId |
integer (int64) |
Query |
expandUnits |
expandUnits |
boolean |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.11. Npt-controller
Npt Controller
2.11.1. Add NPT record
POST /schedule/v1/nonProductiveTimeRecords
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.11.2. Get a NPT record
GET /schedule/v1/nonProductiveTimeRecords/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.11.3. Update a NPT record
PUT /schedule/v1/nonProductiveTimeRecords/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
updatedNpt |
updatedNpt |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.11.4. Get available end times
GET /schedule/v1/nonProductiveTimeRecords/{id}/availableEditTimes
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.12. Path-controller
Path Controller
2.12.1. Get paths
GET /production/v1/lines/{lineId}/paths
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
lineId |
lineId |
integer (int64) |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.12.2. Get a path
GET /production/v1/lines/{lineId}/paths/{pathId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
lineId |
lineId |
integer (int64) |
Path |
pathId |
pathId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.12.3. Get a path
GET /production/v1/paths/{pathId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
301 |
Moved Permanently |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
2.13. Process-order-actuals-controller
Process Order Actuals Controller
2.14. Process-order-controller
Process Order Controller
2.14.1. Add a process order
POST /production/v1/process-orders
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.14.2. Get process orders
GET /production/v1/process-orders
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
lineId |
Production line id |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
statusIds |
Comma separated list of status ids |
string |
2.14.3. Get a process order
GET /production/v1/process-orders/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.14.4. Update a process order
PUT /production/v1/process-orders/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Body |
updatedProcessOrder |
updatedProcessOrder |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.15. Process-order-start-controller
Process Order Start Controller
2.15.1. Add a process order start
POST /production/v1/process-orders/{processOrderId}/starts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processOrderId |
processOrderId |
integer (int64) |
Body |
newProcessOrderStart |
newProcessOrderStart |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.15.2. Get process order starts
GET /production/v1/process-orders/{processOrderId}/starts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
processOrderId |
processOrderId |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
unitIds |
Comma separated list of unit ids. Only return PO Starts for these units. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.15.3. Get a process order start
GET /production/v1/process-orders/{processOrderId}/starts/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Path |
processOrderId |
processOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.15.4. Update a process order start
PUT /production/v1/process-orders/{processOrderId}/starts/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Path |
processOrderId |
processOrderId |
integer (int64) |
Body |
updatedProcessOrderStart |
updatedProcessOrderStart |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.15.5. Delete a process order start
DELETE /production/v1/process-orders/{processOrderId}/starts/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
id |
integer (int64) |
Path |
processOrderId |
processOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.16. Product-controller
Product Controller
2.16.1. Get products
GET /product/v1/products
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
productFamilyIds |
productFamilyIds |
string |
Query |
productGroupIds |
productGroupIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.16.2. Get product by ID
GET /product/v1/products/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.17. Product-family-controller
Product Family Controller
2.17.1. Get product families
GET /product/v1/productFamilies
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.17.2. Get product family by ID
GET /product/v1/productFamilies/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.18. Product-group-controller
Product Group Controller
2.18.1. Get product groups
GET /product/v1/productGroups
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.18.2. Get product group by ID
GET /product/v1/productGroups/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.19. Product-unit-controller
Product Unit Controller
2.19.1. Get product units
GET /product/v1/productUnits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
departmentIds |
departmentIds |
string |
Query |
lineIds |
lineIds |
string |
Query |
productIds |
productIds |
string |
Query |
unitIds |
unitIds |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.19.2. Get product unit by ID
GET /product/v1/productUnits/{id}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden, Authenticated user is not known by MES |
No Content |
404 |
Not Found |
No Content |
2.20. Production-ratio-controller
Production Ratio Controller
2.20.1. Create production ratio
POST /s95/v1/production-ratios
2.20.2. Get production ratios
GET /s95/v1/production-ratios
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ProductionRatio > array |
2.20.3. Delete production ratios
DELETE /s95/v1/production-ratios
2.20.4. Get a production ratio
GET /s95/v1/production-ratios/{ratioId}
2.20.5. Update production ratio
PUT /s95/v1/production-ratios/{ratioId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
ratioId |
ratioId |
integer (int64) |
Body |
input |
input |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
2.21. Unit-controller
Unit Controller
2.21.1. Get all units (for a specific line, if specified)
GET /s95/v1/units
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
expandGroups |
expandGroups |
boolean |
Query |
isInventoryUnit |
isInventoryUnit |
boolean |
Query |
isVirtual |
isVirtual |
boolean |
Query |
lineId |
lineId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Unit > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.21.2. Get a unit
GET /s95/v1/units/{unitId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
unitId |
unitId |
integer (int64) |
Query |
expandGroups |
expandGroups |
boolean |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.21.3. Get Variable categories for a unit
GET /s95/v1/units/{unitId}/variableCategories
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
unitId |
unitId |
integer (int64) |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< VariableCategoryResource > array |
401 |
Unauthorized |
No Content |
404 |
Not Found |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.22. Unit-process-orders-controller
Unit Process Orders Controller
2.22.1. Get all unit process orders (for a specific line, if specified)
GET /production/v1/units
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< UnitProcessOrders > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.22.2. Get process orders for a unit
GET /production/v1/units/{unitId}
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
No Content |
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.23. Variable-category-controller
Variable Category Controller
2.23.1. Get variable Categories
GET /s95/v1/variableCategories
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
name |
name |
string |
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< VariableCategoryResource > array |
401 |
Unauthorized |
No Content |
404 |
Not Found |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.23.2. Get variable Category by Id
GET /s95/v1/variableCategories/{variableCategoryId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
variableCategoryId |
variableCategoryId |
integer (int64) |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.24. Variable-controller
Variable Controller
2.24.1. Get variables
GET /s95/v1/variables
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< Variable > array |
401 |
Unauthorized |
No Content |
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
2.24.2. Get variable
GET /s95/v1/variables/{variableId}
Produces
-
application/vnd.ge.mes.v2.full+json -
application/json;charset=UTF-8 -
application/vnd.ge.mes.v1.full+json
3. Definitions
3.1. ActiveProduct
| Name | Description | Schema |
|---|---|---|
endTime |
The end time of the product record |
string (date-time) |
links |
< Link > array |
|
productId |
Product Id of the product record |
integer (int64) |
startTime |
The start time of the product record |
string (date-time) |
unitId |
Unit Id of the product record |
integer (int64) |
3.2. ActiveProductPage
| Name | Schema |
|---|---|
content |
< ActiveProduct > array |
links |
< Link > array |
page |
3.3. BaseAsset
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
permissions |
< Permission > array |
|
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.4. BaseAssetInfo
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.5. CategoryStatistics
| Name | Description | Schema |
|---|---|---|
categoryDisplayName |
The display name of the category |
string |
categoryId |
Unique identifier of the category |
integer (int64) |
count |
The count of the items in this category |
integer (int64) |
name |
string |
3.7. ColorSchemeFieldInfo
| Name | Description | Schema |
|---|---|---|
category |
Category of the Color Scheme Field. |
enum (AutologCellForeground, AutologCellBackground, Spreadsheet, Trendsheet, DelayReports, QualityReports, COAReports, OtherReports, ProficyWebCharts, Downtime, Waste) |
color |
Color Code. |
string |
colorSchemeFieldDesc |
string |
|
colorSchemeFieldId |
integer (int64) |
|
colorSchemeInfo |
Color Scheme to which Color Scheme Field belongs to. |
3.8. ColorSchemeFieldInfoResources
| Name | Schema |
|---|---|
content |
< ColorSchemeFieldInfo > array |
links |
< Link > array |
3.9. ColorSchemeInfo
| Name | Schema |
|---|---|
colorSchemeDesc |
string |
colorSchemeId |
integer (int64) |
3.10. Comment
| Name | Description | Schema |
|---|---|---|
commentId |
Unique identifier of this comment record |
integer (int64) |
commentText |
The text of the comment |
string |
commentTime |
The time this comment was entered |
string (date-time) |
links |
< Link > array |
|
threadId |
Comment thread this record is part of |
integer (int64) |
user |
The user who entered this comment |
3.11. CommentPage
| Name | Schema |
|---|---|
content |
< Comment > array |
links |
< Link > array |
page |
3.12. DataSourceInfo
| Name | Schema |
|---|---|
nodeId |
string |
systemName |
string |
systemType |
string |
3.13. Department
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
lines |
Collection of lines belonging to this department |
|
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.14. Downtime
| Name | Description | Schema |
|---|---|---|
action1 |
The Level 1 Action of the downtime record. |
|
action2 |
The Level 2 Action of the downtime record. |
|
action3 |
The Level 3 Action of the downtime record. |
|
action4 |
The Level 4 Action of the downtime record. |
|
actionCommentsThreadId |
The Action Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
asset |
The Asset(Unit) of the downtime record |
|
category |
The Category of the downtime record |
|
cause1 |
The Level 1 Cause (Reason) of the downtime record. |
|
cause2 |
The Level 2 Cause (Reason) of the downtime record. |
|
cause3 |
The Level 3 Cause (Reason) of the downtime record. |
|
cause4 |
The Level 4 Cause (Reason) of the downtime record. |
|
causeCommentsThreadId |
The Cause Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
department |
The Department of the downtime record |
|
downtimeId |
The Unique Id of the downtime record |
integer (int64) |
duration |
The Duration of the downtime record |
number (double) |
eSignatureId |
The E-Signature Id of the downtime record. Points to a Electronic signature record. |
integer (int64) |
endTime |
The End Time of the downtime record |
string (date-time) |
eventStatus |
The Event Status of the downtime record |
|
fault |
The Fault of the downtime record |
|
line |
The Line of the downtime record |
|
links |
< Link > array |
|
nptId |
The Id of the Non-Productive Time record associated with this downtime record. Will only be present if this is a Non-Productive Time cause record. |
integer (int64) |
permissions |
< Permission > array |
|
reasonTreeDataId |
The Reason Tree Data Id of the downtime record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the cause (reason) levels have been entered to the lowest required level. |
boolean |
researchCloseDate |
The Research Close Date of the downtime record. |
string (date-time) |
researchCommentsThreadId |
The Research Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
researchOpenDate |
The Research Open Date of the downtime record. |
string (date-time) |
researchStatus |
The Research Status of the downtime record. |
|
researchUser |
The Research User of the downtime record. |
|
startTime |
The Start Time of the downtime record |
string (date-time) |
status |
The Status of the downtime record |
|
uptime |
The Up Time of the downtime record |
number (double) |
user |
The User who entered the downtime record. |
3.15. DowntimeDurationFilter
| Name | Description | Schema |
|---|---|---|
maxDuration |
The maximum duration to be included in the filtered results |
number (double) |
minDuration |
The minimum duration to be included in the filtered results |
number (double) |
3.16. DowntimeLocation
| Name | Description | Schema |
|---|---|---|
asset |
The Asset (Unit) that identifies this location |
|
department |
The Department this location belongs to |
|
line |
The Line this location belongs to |
3.17. DowntimePage
| Name | Schema |
|---|---|
content |
< Downtime > array |
links |
< Link > array |
page |
3.18. DowntimeRecord
| Name | Description | Schema |
|---|---|---|
action1 |
The Level 1 Action of the downtime record. |
|
action2 |
The Level 2 Action of the downtime record. |
|
action3 |
The Level 3 Action of the downtime record. |
|
action4 |
The Level 4 Action of the downtime record. |
|
actionCommentsThreadId |
The Action Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
asset |
The Asset(Unit) of the downtime record |
|
category |
The Category of the downtime record |
|
cause1 |
The Level 1 Cause (Reason) of the downtime record. |
|
cause2 |
The Level 2 Cause (Reason) of the downtime record. |
|
cause3 |
The Level 3 Cause (Reason) of the downtime record. |
|
cause4 |
The Level 4 Cause (Reason) of the downtime record. |
|
causeCommentsThreadId |
The Cause Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
department |
The Department of the downtime record |
|
downtimeId |
The Unique Id of the downtime record |
integer (int64) |
duration |
The Duration of the downtime record |
number (double) |
eSignatureId |
The E-Signature Id of the downtime record. Points to a Electronic signature record. |
integer (int64) |
endTime |
The End Time of the downtime record |
string (date-time) |
eventStatus |
The Event Status of the downtime record |
|
fault |
The Fault of the downtime record |
|
line |
The Line of the downtime record |
|
nptId |
The Id of the Non-Productive Time record associated with this downtime record. Will only be present if this is a Non-Productive Time cause record. |
integer (int64) |
reasonTreeDataId |
The Reason Tree Data Id of the downtime record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the cause (reason) levels have been entered to the lowest required level. |
boolean |
researchCloseDate |
The Research Close Date of the downtime record. |
string (date-time) |
researchCommentsThreadId |
The Research Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
researchOpenDate |
The Research Open Date of the downtime record. |
string (date-time) |
researchStatus |
The Research Status of the downtime record. |
|
researchUser |
The Research User of the downtime record. |
|
startTime |
The Start Time of the downtime record |
string (date-time) |
status |
The Status of the downtime record |
|
uptime |
The Up Time of the downtime record |
number (double) |
user |
The User who entered the downtime record. |
3.19. DowntimeRecords
| Name | Description | Schema |
|---|---|---|
downtimeRecords |
The list of downtime records |
< DowntimeRecord > array |
3.20. DowntimeSummary
| Name | Description | Schema |
|---|---|---|
categories |
List of category statistics. This provides counts of records available by category. |
< CategoryStatistics > array |
downtimeRecords |
Paged list of downtime records that match the request criteria |
|
filterCategories |
The categories available to filter by |
< IdNameValue > array |
filterDuration |
The duration available to filter by |
|
filterLocations |
The locations available to filter by |
< DowntimeLocation > array |
filterStatuses |
The statuses available to filter by |
< IdNameValue > array |
links |
< Link > array |
3.22. ExecutionPath
| Name | Description | Schema |
|---|---|---|
code |
Customer Code for the path |
string |
commentsThreadId |
The Comments Thread Id of the path record. Points to a chain of comments. |
integer (int64) |
description |
Path Description |
string |
isLineProduction |
Production on this path should count towards line production |
boolean |
isScheduleControlled |
The execution path is controlled by a schedule |
boolean |
lineId |
The production line id of this path |
integer (int64) |
links |
< Link > array |
|
pathId |
Unique Id of the path record |
integer (int64) |
pathUnits |
The pathUnits associated with this path |
< ExecutionPathUnitInfo > array |
scheduleControlType |
The schedule control type setting |
enum (AllUnitsRunSameScheduleSimultaneously, ScheduleFlowsByEvent, ScheduleFlowsIndependently) |
3.23. ExecutionPathPage
| Name | Schema |
|---|---|
content |
< ExecutionPath > array |
links |
< Link > array |
page |
3.24. ExecutionPathUnitInfo
| Name | Description | Schema |
|---|---|---|
executionPathUnitId |
Unique Id of the Execution Path Unit record |
integer (int64) |
isProductionPoint |
Is this unit the production counting unit of the path |
boolean |
isSchedulePoint |
Is this unit the scheduling unit of the path |
boolean |
pathId |
The Path Id of the path this unit is a member of |
integer (int64) |
unitId |
The production unit id |
integer (int64) |
unitOrder |
The execution order of this unit in the path |
integer (int32) |
3.25. Fault
| Name | Description | Schema |
|---|---|---|
faultId |
The Unique Id of the fault |
integer (int64) |
links |
< Link > array |
|
name |
The descriptive name of the fault |
string |
reason1 |
Level 1 reason associated with this fault |
|
reason2 |
Level 2 reason associated with this fault |
|
reason3 |
Level 3 reason associated with this fault |
|
reason4 |
Level 4 reason associated with this fault |
3.26. FaultPage
| Name | Schema |
|---|---|
content |
< Fault > array |
links |
< Link > array |
page |
3.27. Group
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
variables |
Collection of variables belonging to this group |
3.29. IdNameValue
| Name | Description | Schema |
|---|---|---|
id |
The unique ID of the entity |
integer (int64) |
name |
The name of the entity |
string |
3.30. Line
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
isRouteEnabled |
Is this line route enabled. A route enabled line is ready to be used by the route service and has been properly configured. |
boolean |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
units |
Collection of Units belonging to this Line |
3.31. LineCollection
| Name | Schema |
|---|---|
collection |
|
content |
< Line > array |
links |
< Link > array |
3.33. Npt
| Name | Description | Schema |
|---|---|---|
asset |
The Asset(Unit) of the NPT record |
|
commentId |
The Comment Id of the NPT record. Points to a chain of comments. |
integer (int64) |
department |
Department of the NPT record |
|
endTime |
The End Time of the NPT record |
string (date-time) |
entryOn |
The Entry On time of the NPT record. |
string (date-time) |
line |
Line of the NPT record |
|
links |
< Link > array |
|
nptId |
Unique ID of the NPT record |
integer (int64) |
reason1 |
The Level 1 Reason of the NPT record. |
|
reason2 |
The Level 2 Reason of the NPT record. |
|
reason3 |
The Level 3 Reason of the NPT record. |
|
reason4 |
The Level 4 Reason of the NPT record. |
|
reasonTreeDataId |
The Reason Tree Data Id of the NPT record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the reason levels have been entered to the lowest required level. |
boolean |
startTime |
The Start Time of the NPT record |
string (date-time) |
user |
The User who entered the NPT. This may be a system user if the event was generated by a service. |
3.34. NptRecord
| Name | Description | Schema |
|---|---|---|
asset |
The Asset(Unit) of the NPT record |
|
commentId |
The Comment Id of the NPT record. Points to a chain of comments. |
integer (int64) |
department |
Department of the NPT record |
|
endTime |
The End Time of the NPT record |
string (date-time) |
entryOn |
The Entry On time of the NPT record. |
string (date-time) |
line |
Line of the NPT record |
|
nptId |
Unique ID of the NPT record |
integer (int64) |
reason1 |
The Level 1 Reason of the NPT record. |
|
reason2 |
The Level 2 Reason of the NPT record. |
|
reason3 |
The Level 3 Reason of the NPT record. |
|
reason4 |
The Level 4 Reason of the NPT record. |
|
reasonTreeDataId |
The Reason Tree Data Id of the NPT record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the reason levels have been entered to the lowest required level. |
boolean |
startTime |
The Start Time of the NPT record |
string (date-time) |
user |
The User who entered the NPT. This may be a system user if the event was generated by a service. |
3.35. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.37. ProcessOrder
| Name | Description | Schema |
|---|---|---|
adjustedQuantity |
Actual quantity of product this process order has produced |
number (double) |
bomFormulationId |
Specifies the BOM Formulation Id of the order |
integer (int64) |
commentsThreadId |
The Comments Thread Id of the process order record. Points to a chain of comments. |
integer (int64) |
controlTypeId |
Specifies the control type of the order |
integer (int64) |
impliedSequence |
Execution sequence is normally by planned start, but this can override the sequence |
integer (int64) |
links |
< Link > array |
|
name |
Descriptive Name of the process order |
string |
orderTypeId |
Specifies the type of the order (Production Plan Type) |
integer (int64) |
pathId |
The Path Id this process order uses |
integer (int64) |
plannedEndTime |
The planned time to finish the order |
string (date-time) |
plannedQuantity |
Quantity of product this process order is requesting |
number (double) |
plannedStartTime |
The planned time to start the order |
string (date-time) |
processOrderId |
Unique Id of the process order record |
integer (int64) |
productId |
Product Id of the product this process order is requesting |
integer (int64) |
productionRate |
Production rate of this product |
number (double) |
statusId |
The status of the process order |
integer (int64) |
userId |
The User who entered the process order. |
integer (int64) |
3.38. ProcessOrderActuals
| Name | Description | Schema |
|---|---|---|
actualBadItems |
Count of bad events (Items) |
integer (int64) |
actualBadQuantity |
Quantity of bad production |
number (double) |
actualDownTime |
Minutes of downtime |
number (double) |
actualEndTime |
The actual time the order was ended |
string (date-time) |
actualGoodItems |
Count of good events (Items) |
integer (int64) |
actualGoodQuantity |
Quantity of good production |
number (double) |
actualRunningTime |
Minutes of running time |
number (double) |
actualStartTime |
The actual time the order was started |
string (date-time) |
alarmCount |
Number of alarms on this order |
integer (int64) |
links |
< Link > array |
|
pathId |
The Path Id this process order uses |
integer (int64) |
predictedRemainingDuration |
Predicted time (minutes) remaining to complete this order |
number (double) |
predictedRemainingQuantity |
Predicted quantity remaining to be produced |
number (double) |
predictedTotalDuration |
Predicted total running time of the order |
number (double) |
processOrderId |
Unique Id of the process order record |
integer (int64) |
3.39. ProcessOrderPage
| Name | Schema |
|---|---|
content |
< ProcessOrder > array |
links |
< Link > array |
page |
3.40. ProcessOrderPlanInfo
| Name | Description | Schema |
|---|---|---|
adjustedQuantity |
Actual quantity of product this process order has produced |
number (double) |
bomFormulationId |
Specifies the BOM Formulation Id of the order |
integer (int64) |
commentsThreadId |
The Comments Thread Id of the process order record. Points to a chain of comments. |
integer (int64) |
controlTypeId |
Specifies the control type of the order |
integer (int64) |
impliedSequence |
Execution sequence is normally by planned start, but this can override the sequence |
integer (int64) |
name |
Descriptive Name of the process order |
string |
orderTypeId |
Specifies the type of the order (Production Plan Type) |
integer (int64) |
pathId |
The Path Id this process order uses |
integer (int64) |
plannedEndTime |
The planned time to finish the order |
string (date-time) |
plannedQuantity |
Quantity of product this process order is requesting |
number (double) |
plannedStartTime |
The planned time to start the order |
string (date-time) |
processOrderId |
Unique Id of the process order record |
integer (int64) |
productId |
Product Id of the product this process order is requesting |
integer (int64) |
productionRate |
Production rate of this product |
number (double) |
statusId |
The status of the process order |
integer (int64) |
userId |
The User who entered the process order. |
integer (int64) |
3.41. ProcessOrderStart
| Name | Description | Schema |
|---|---|---|
commentsThreadId |
The Comments Thread Id of the process order start record. Points to a chain of comments. |
integer (int64) |
departmentId |
The ID of the department that this start is associated with |
integer (int64) |
endTime |
The end time of the process order start record |
string (date-time) |
lineId |
The ID of the department that this start is associated with |
integer (int64) |
links |
< Link > array |
|
processOrderId |
Unique Id of the process order record that this start is associated with |
integer (int64) |
processOrderSetupId |
Unique Id of the process order setup record that this start is associated with |
integer (int64) |
processOrderStartId |
Unique Id of the process order start record |
integer (int64) |
startTime |
The start time of the process order start record |
string (date-time) |
unitId |
The ID of the unit that this start is associated with |
integer (int64) |
userId |
The User who entered the process order start. |
integer (int64) |
3.42. ProcessOrderStartCreateInfo
| Name | Description | Schema |
|---|---|---|
commentsThreadId |
The Comments Thread Id of the process order start record. Points to a chain of comments. |
integer (int64) |
endTime |
The end time of the process order start record |
string (date-time) |
processOrderSetupId |
Unique Id of the process order setup record that this start is associated with |
integer (int64) |
startTime |
The start time of the process order start record |
string (date-time) |
unitId |
The ID of the unit that this start is associated with |
integer (int64) |
3.43. ProcessOrderStartPage
| Name | Schema |
|---|---|
content |
< ProcessOrderStart > array |
links |
< Link > array |
page |
3.44. ProcessOrderStartUpdateInfo
| Name | Description | Schema |
|---|---|---|
commentsThreadId |
The Comments Thread Id of the process order start record. Points to a chain of comments. |
integer (int64) |
endTime |
The end time of the process order start record |
string (date-time) |
processOrderSetupId |
Unique Id of the process order setup record that this start is associated with |
integer (int64) |
startTime |
The start time of the process order start record |
string (date-time) |
3.45. Product
| Name | Description | Schema |
|---|---|---|
code |
The product code |
string |
description |
The description of the product |
string |
links |
< Link > array |
|
productFamilyId |
The id of the product family this product is a member of |
integer (int64) |
productId |
The unique ID of the product |
integer (int64) |
3.46. ProductFamily
| Name | Description | Schema |
|---|---|---|
description |
The product family’s description |
string |
links |
< Link > array |
|
productFamilyId |
The unique Id of the product family |
integer (int64) |
3.47. ProductFamilyPage
| Name | Schema |
|---|---|
content |
< ProductFamily > array |
links |
< Link > array |
page |
3.48. ProductGroup
| Name | Description | Schema |
|---|---|---|
description |
The property group’s description |
string |
links |
< Link > array |
|
productGroupId |
The unique Id of the product group |
integer (int64) |
3.49. ProductGroupPage
| Name | Schema |
|---|---|
content |
< ProductGroup > array |
links |
< Link > array |
page |
3.50. ProductPage
| Name | Schema |
|---|---|
content |
< Product > array |
links |
< Link > array |
page |
3.51. ProductUnit
| Name | Description | Schema |
|---|---|---|
departmentId |
The ID of the department |
integer (int64) |
lineId |
The ID of the department |
integer (int64) |
links |
< Link > array |
|
productId |
The unique ID of the department |
integer (int64) |
productUnitId |
The ID of the production unit |
string |
unitId |
The ID of the unit |
integer (int64) |
3.52. ProductUnitPage
| Name | Schema |
|---|---|
content |
< ProductUnit > array |
links |
< Link > array |
page |
3.53. ProductionRatio
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
productId |
The product associated with this ratio. |
integer (int64) |
unitRatios |
The collection of unit ratio overrides. |
< UnitRatioInfo > array |
3.54. ProductionRatioInfo
| Name | Description | Schema |
|---|---|---|
productId |
The product associated with this ratio. |
integer (int64) |
unitRatios |
The collection of unit ratio overrides. |
< UnitRatioInfo > array |
3.55. Ratio
| Name | Description | Schema |
|---|---|---|
in |
The antecedent, or top part, of the ratio |
integer (int32) |
out |
The consequent, or bottom part, of the ratio |
integer (int32) |
3.56. ResponseEntity
| Name | Schema |
|---|---|
body |
object |
statusCode |
enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511) |
statusCodeValue |
integer (int32) |
3.57. SecureCommentRecord
| Name | Description | Schema |
|---|---|---|
commentId |
Unique identifier of this comment record |
integer (int64) |
commentText |
The text of the comment |
string |
commentTime |
The time this comment was entered |
string (date-time) |
commentType |
The comment table id (Comment Type) of this comment |
enum (Tests, Variables, Product, ProductionEvent, SheetColumns, AlarmTemplates, AlarmTemplateVariableData, ProdUnits, UDE, UDECause, UDEAction, UDEResearch, AlarmCause, AlarmAction, AlarmResearch, DowntimeCause, DowntimeAction, DowntimeResearch, ProductChange, WasteCause, WasteAction, WasteResearch, EDModels, Calculations, EventSubtypes, EventConfiguration, CustomerOrders, CustomerOrderLineItems, EDFields, ProductionPlan, Characteristics, ProductionLines, ProductionGroups, SecurityGroups, Specifications, ProductionSetup, ProductionSetupDetail, CrewSchedule, ActiveSpecs, COA, COAItems, ContainerLocation, CustomerCOA, EventDetails, EventReasons, GB_DSet, GB_RSum, InProcessBins, PrdExecInputEvent, ProductFamily, ProductProperties, ProductionPlanStarts, ReportTreeTemplates, ReportWebpages, SavedQueries, Sheets, Shipment, ShipmentLineItems, StoredProcs, DowntimeSummaryAction, DowntimeSummaryCause, DowntimeSummaryResearch, TransProperties, TransVariables, Transactions, VarSpecs, DefectDetailsAction, DefectDetailsCause, DefectDetailsResearch, PrdExecPaths, UnitLocation, Departments, PrdExecPathUnitStarts, NonProductiveDetail, Activity) |
threadId |
Comment thread this record is part of |
integer (int64) |
unitId |
Unit this comment is associated with |
integer (int64) |
user |
The user who entered this comment |
3.58. TimeRange
| Name | Description | Schema |
|---|---|---|
endTime |
The end time |
string (date-time) |
links |
< Link > array |
|
startTime |
The start time |
string (date-time) |
3.59. Unit
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
isInventoryUnit |
Is this unit an inventory unit. A inventory unit is a storage unit. |
boolean |
isVirtual |
Is this unit a virtual unit. A virtual unit is a tracking unit. It doesn’t have physical assets associated with it. |
boolean |
lineId |
The line this unit belongs to |
integer (int64) |
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
unitRank |
This unit’s rank |
integer (int32) |
units |
Collection of Groups belonging to this Unit |
3.60. UnitCollection
| Name | Schema |
|---|---|
collection |
|
content |
< Unit > array |
links |
< Link > array |
3.61. UnitProcessOrders
| Name | Description | Schema |
|---|---|---|
associatedProcessOrders |
List of associated process orders for this unit in order of forecast execution. Does not include the current active process order. |
< ProcessOrder > array |
currentEffectiveRatio |
The effective ratio describing the relative number of inputs to create some number of outputs. Only valid when the unit has a current process order. |
|
currentProcessOrder |
The process order currently active on this unit |
|
currentScrapFactor |
The scrap factor for unit |
number |
links |
< Link > array |
|
unitId |
The unique ID of the unit |
integer (int64) |
unitStartTime |
The time the current process order started on this unit |
string (date-time) |
3.62. UnitRatioInfo
| Name | Description | Schema |
|---|---|---|
ratio |
The ratio |
|
unitId |
The unit ID |
integer (int64) |
3.63. Variable
| Name | Description | Schema |
|---|---|---|
assetId |
The asset ID |
integer (int64) |
inputTag |
The Input Tag data source for this variable |
|
links |
< Link > array |
|
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.64. VariableCategoryResource
| Name | Description | Schema |
|---|---|---|
id |
Unique Identifier for the Event Subtype |
integer (int64) |
links |
< Link > array |
|
name |
Value for Event subtype |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : http://localhost:8080/uaa/oauth/authorize
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://localhost:8080/uaa/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://localhost:8080/uaa/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |