1. Overview
Microservice containing the business logic for managing operator-app-service.
1.2. Tags
-
activity-controller : Activity Controller
-
application-tab-controller : Application Tab Controller
-
bom-reallocation-genealogy-controller : Bom Reallocation Genealogy Controller
-
common-bom-controller : Common Bom Controller
-
consumption-operations-controller : Consumption Operations Controller
-
document-management-controller : Document Management Controller
-
engineering-unit-controller : Engineering Unit Controller
-
external-config-controller : External Config Controller
-
labor-type-controller : Labor Type Controller
-
material-controller : Material Controller
-
operator-controller : Operator Controller
-
permission-check-controller : Permission Check Controller
-
properties-controller : Properties Controller
-
user-settings-controller : User Settings Controller
-
work-order-component-controller : Work Order Component Controller
-
work-order-socket-controller : Work Order Socket Controller
-
work-queue-controller : Work Queue Controller
2. Resources
2.1. Activity-controller
Activity Controller
2.1.1. Notify the active segmentactuals to publish the activity variable counts events
POST /activities/activityVariableCounts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
activityVariablesRequest |
activityVariablesRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
202 |
Accepted |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
UnProcessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.1.2. Fetches List of activities containing their variable counts
GET /activities/activityVariableCounts
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
eventInfo |
Accept List of materialLotActualId and segmentActualId respectively with comma seperated - Ex:146:252,181:333 |
string |
Query |
eventType |
Type of eventNumbers provided above [all the eventIds should belong to same type] |
enum (UserDefinedEvent) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
UnProcessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.1.3. activties
GET /activities/ids
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
materialLotActualId |
materialLotActualId |
integer (int64) |
Query |
segmentActualId |
segmentActualId |
integer (int64) |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
UnProcessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.1.4. To check form is Custom form
GET /activities/isCustomform
|
Caution
|
operation.deprecated |
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
materialLotActualId |
materialLotActualId |
integer (int64) |
Query |
segmentActualId |
segmentActualId |
integer (int64) |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
UnProcessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.2. Application-tab-controller
Application Tab Controller
2.2.1. Get tabs mapped to appId.
GET /apps/{appId}/tabs
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
|
Query |
enabled |
enabled |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
size |
size |
integer (int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ApplicationTabResponseResults > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.2.2. Get tab details mapped to appId
GET /apps/{appId}/tabs/{tabId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
appId |
appId |
integer (int64) |
Path |
tabId |
tabId |
integer (int64) |
Query |
segmentId |
segmentId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
2.3. Bom-reallocation-genealogy-controller
Bom Reallocation Genealogy Controller
2.3.1. Get reallocation genealogy info
GET /reallocation/genealogy
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomItemId |
bomItemId |
integer (int64) |
Query |
segmentId |
segmentId |
integer (int64) |
Query |
sourceLotId |
sourceLotId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ConsumptionRecordInfo > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.4. Common-bom-controller
Common Bom Controller
2.4.1. Get Permission on a resource
GET /api/checkPermission
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
permissionName |
permissionName |
string |
Query |
resourceId |
ResourceId |
integer (int64) |
Query |
resourceType |
Resource Type |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
boolean |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.4.2. Get Custom Property Details for entity, currently only productId is supported as entityType
GET /api/customProperties
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
entityId |
Id of the entity for which |
integer (int64) |
|
Query |
entityType |
entityType |
enum (Product) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ProductCustomProperty > array |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, properties not available |
|
500 |
Internal Server Error |
|
503 |
Service Unavailable |
2.4.3. Get Units/equipments to create the source lot
GET /api/equipments
Description
For Units to create the lots on: following units will be considered and then ProductId and engineeringUnitId check will be applied,
if no units returned then configuration for StorageUnit of item and RawMaterial Input unit configuration on production counting unit should be checked.
If the storage unit is configured on the bomItem then use it.
ELSE If RawMaterialInput Source Units are configured on the productionCountingUnits of path of process order then use the Source Units.
ELSE use all the units
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
bomItemStorageUnitId |
if bomItemStorageUnitId is non null then this storage unit details will be returned if it can support the product and bomItemEngineeringUnitId |
integer (int64) |
Query |
engineeringUnitId |
Bom Item Engineering Unit Id |
integer (int64) |
Query |
processOrderId |
processOrderId is used to check the RawMaterialInput Source Units configuration, if not provided then this check will be ignored |
integer (int64) |
Query |
productId |
Product Id to get the equipments |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< UnitInfo > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
503 |
Service Unavailable |
No Content |
2.4.4. consume Lot
POST /api/lot/consume
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
createLot |
whether to create lot as well, defaults to true |
boolean |
|
Body |
lotCreateAndConsumeRequest |
Body for creation of source lot and consumption operation |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
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 |
No Content |
503 |
Service Unavailable |
No Content |
2.4.5. Search for the lots.
GET /api/lots
Description
For Units to partial search the lots on:-
bomItemStorageUnitId and processOrderId are used to find out the units on which the production events is searched on, based on the below logic:
If the storage unit is there then use it.
ELSE If RawMaterialInput Source Units are configured on the productionCountingUnits of path of process order then use the Source Units.
ELSE don’t apply UnitIds as filter to search the lots
If exact search is performed then bomItemStorageUnitId and processOrderId will be used just to populate isValidUnitForConsumption flag in the response if the exact lot doesn’t belong to those units
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
bomItemStorageUnitId |
lots will be searched from this unit if it is provided in case of partial search. In case of exact search there will be a flag [isValidUnitForConsumption] set in the response saying if lot belongs to this storage unit or not. |
integer (int64) |
|
Query |
bomItemUnitOfMeasureId |
BOM Item unit of measure Id to filter the lots with incorrect UOMId |
integer (int64) |
|
Query |
lotIdentifier |
lot identifier (use exact event_num/lot_identifier for this property) |
string |
|
Query |
lotIdentifierPartialSearch |
Whether to do partial match using lotIdentifier param or exact match. Default value false - lotIdentifier param will be used for exact match to Event_Num or lot_Identifier. True - lotIdentifier param will be used for partial match to Event_Num or lot_Identifier |
boolean |
|
Query |
orderType |
Order Type on which the lots are to be searched on, will be required if orderType is WorkOrder and includeLotsWithImplicitProduct search is not required |
enum (ProcessOrder, WorkOrder) |
|
Query |
processOrderId |
processOrderId is used to check the RawMaterialInput Source Units configuration, if not provided then this check will be ignored |
integer (int64) |
|
Query |
productId |
productId the lot which is being searched |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< BomMaterialLotInfo > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.4.6. Consumption details for the item
GET /api/orders/{orderId}/bom/{itemId}/consumptions
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
itemId |
bom itemId for which consumption history is required |
integer (int64) |
|
Path |
orderId |
order id, either work orderId or process order id |
integer (int64) |
|
Query |
bomItemProductId |
Product Id of the bomItem. |
integer (int64) |
|
Query |
bomItemQuantityPrecision |
QuantityPrecision of the bomItem. |
integer (int32) |
|
Query |
bomItemStorageUnitId |
Storage Unit Id of the bomItem. |
integer (int64) |
|
Query |
bomItemUnitOfMeasureId |
UnitOfMeasureId of the bomItem. |
integer (int64) |
|
Query |
consumptionRecordId |
consumptionRecordId of the consumption operation. |
integer (int64) |
|
Query |
orderType |
orderType |
enum (ProcessOrder, WorkOrder) |
|
Query |
segmentId |
segmentId |
integer (int64) |
|
Query |
sourceMaterialLotId |
sourceMaterialLotId |
integer (int64) |
|
Query |
targetLotId |
targetLot against which consumption history is required. if not passed then roll up consumption of process order will be returned in case of order type as process order. empty list will be retuned if order type is workorder |
integer (int64) |
|
Query |
totalQuantityToConsume |
totalRequiredQuantityToConsume used to calculate BomRequiredForConsumption |
number (double) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.4.7. Get MaterialLot Status by Id from product service
GET /api/statuses/{materialLotStatusId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotStatusId |
MaterialLot Status ID To Get a MaterialLot Status Details. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLotStatus > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.4.8. Get BOM Details for the process order
GET /api/{orderId}/boms
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
orderId |
Id of ProcessOrder or WorkOrder. |
integer (int64) |
|
Query |
orderType |
OrderType of the orderId, it can be ProcessOrder or WorkOrder |
enum (ProcessOrder, WorkOrder) |
|
Query |
plannedQuantity |
Relevant only if ordertype is WorkOrder. Default Value is 1 |
integer (int32) |
|
Query |
segmentId |
segmentId, Relevant only if ordertype is WorkOrder. |
integer (int64) |
|
Query |
targetLotId |
Id of the targetLot. Should be passed null if roll up consumption for process order is required |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
|
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
2.5. Consumption-operations-controller
Consumption Operations Controller
2.5.1. Create a consumption record
POST /consumptionOperations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
resourceId |
EntityModel id to validate the permission forconsumption. |
integer (int64) |
Query |
resourceType |
EntityModel Type to validate the permission forconsumption. |
string |
Body |
consumptionRecord |
consumptionRecord |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
OK |
|
400 |
Invalid data supplied. See message for details. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
503 |
Service Unavailable |
2.5.2. Get Consumption lots
GET /consumptionOperations
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
bomItemId |
Consumption records for bomItemId. |
integer (int64) |
|
Query |
id |
ID of consumption record / Component_Id of event_components. |
integer (int64) |
|
Query |
quantityPrecision |
quantityPrecision |
integer (int32) |
|
Query |
quantityRaw |
quantityRaw |
number (double) |
|
Query |
segmentId |
Consumption records for segmentId. |
integer (int64) |
|
Query |
sourceMaterialLotId |
Source Material Lot ID the product being consumed. |
integer (int64) |
|
Query |
targetMaterialLotId |
Target material Lot ID the product being manufactured. |
integer (int64) |
|
Query |
workOrderId |
Consumption records for workOrderId. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ConsumptionRecordInfo > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
No Content |
422 |
Unprocessable Entity |
No Content |
503 |
Service Unavailable |
No Content |
2.5.3. Create lot and consume that Lot
POST /consumptionOperations/materialLot
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
resourceId |
EntityModel id to validate the permission forconsumption. |
integer (int64) |
Query |
resourceType |
EntityModel Type to validate the permission forconsumption. |
string |
Body |
materialLotConsumptionRequest |
materialLotConsumptionRequest |
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 |
No Content |
503 |
Service Unavailable |
No Content |
2.6. Document-management-controller
Document Management Controller
2.6.1. Get document
GET /documents/attachment
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
attachmentName |
attachment Name |
string |
Query |
documentId |
document id |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
500 |
Internal server error |
2.7. Engineering-unit-controller
Engineering Unit Controller
2.7.1. Get All Units By ProductId
GET /engineeringunits
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
engineeringUnitId |
engineeringUnitId |
integer (int64) |
Query |
productId |
productId |
string |
Query |
unitId |
unitId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialInfo > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.8. External-config-controller
External Config Controller
2.8.1. Get Configurations
GET /v1/configurations
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
actionId |
actionId |
integer (int32) |
|
Query |
actionName |
actionName |
string |
|
Query |
actionTypeId |
actionTypeId |
integer (int32) |
|
Query |
configId |
configId |
integer (int64) |
|
Query |
includeDeleted |
includeDeleted |
boolean |
|
Query |
page |
page |
integer (int32) |
|
Query |
segmentId |
segmentId |
integer (int64) |
|
Query |
size |
size |
integer (int32) |
|
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No Content, Error retrieving actions |
|
401 |
User Unauthorized |
No Content |
500 |
Internal Server Error |
2.9. Labor-type-controller
Labor Type Controller
2.10. Material-controller
Material Controller
2.10.1. Get all the materials
GET /materials
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialInfo > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.10.2. Get list of materialLots and their properties
GET /materials/materialLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
lotIdentifier |
lot identifier (use event_num/lot_identifier for this property at this time) |
string |
Query |
productId |
Product ID (applied product id) to retrieve properties of materialLots. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialInfo > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.10.3. Get product families
GET /materials/productFamilies
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
page |
integer (int32) |
Query |
productId |
productId |
integer (int64) |
Query |
size |
size |
integer (int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< ProductFamilyPage > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.10.4. Get MaterialLot Status by Id from product service
GET /materials/statuses/{materialLotStatusId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotStatusId |
MaterialLot Status ID To Get a MaterialLot Status. |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< MaterialLotStatus > array |
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11. Operator-controller
Operator Controller
2.11.1. Query Operations
GET /operations
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
clockedOn |
clockedOn |
boolean |
|
Query |
completedAfter |
completedAfter |
string |
|
Query |
completedBefore |
completedBefore |
string |
|
Query |
equipmentId |
equipmentId |
< integer (int64) > array(multi) |
|
Query |
isCustomDate |
isCustomDate |
boolean |
|
Query |
limitSearchResult |
limitSearchResult |
boolean |
|
Query |
materialLotIdentifier |
materialLotIdentifier |
string |
|
Query |
onHold |
onHold |
boolean |
|
Query |
operationName |
operationName |
string |
|
Query |
orderBy |
orderBy |
string |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
producedMaterialId |
producedMaterialId |
< integer (int64) > array(multi) |
|
Query |
productFamilyId |
productFamilyId |
< integer (int64) > array(multi) |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
status |
status |
< string > array(multi) |
|
Query |
workOrderId |
workOrderId |
integer (int64) |
|
Query |
workOrderName |
workOrderName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.11.2. Get the BOMs of particular oparation by work Order ID and segment ID
GET /operations/boms
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
plannedQuantity |
Lot plannedQuantity |
integer (int64) |
Query |
segmentId |
Id of the segment resource |
integer (int64) |
Query |
targetLotId |
Target lot Id of the segment consumed lot |
integer (int64) |
Query |
workOrderId |
Id of the work order resource |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.11.3. Clock on/off an operation
POST /operations/clock
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
Success |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11.4. Complete of an operation
POST /operations/complete
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11.5. fetchTargetMaterialLotId
GET /operations/materialLotActuals/{materialLotActualId}/targetMaterialLot
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
materialLotActualId |
materialLotActualId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
2.11.6. Operation details
GET /operations/segmentActuals/{segmentActualId}/details
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
segmentActualId |
segmentActualId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.11.7. fetchTargetMaterialLot
GET /operations/segmentActuals/{segmentActualId}/targetMaterialLot
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
segmentActualId |
segmentActualId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
2.11.8. To get unconsumed BOM count in a segment/operation
GET /operations/segmentActuals/{segmentActualId}/unConsumedBomCount
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
segmentActualId |
segmentActualId |
integer (int64) |
Query |
plannedQuantity |
plannedQuantity |
integer (int32) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.11.9. Documents of an operation
GET /operations/segments/{segmentId}/documents
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
segmentId |
segmentId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11.10. Skip an operation
POST /operations/skip
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
Success |
object |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11.11. Units of all lines
GET /operations/units
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< UnitsData > array |
401 |
Unauthorized |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.11.12. Operation
GET /operations/{segmentActualId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
segmentActualId |
segmentActualId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.12. Permission-check-controller
Permission Check Controller
2.12.1. checkPermission
GET /checkPermission
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
permissionName |
Permission Scope |
string |
Query |
resourceId |
UnitId or LineId |
integer (int32) |
Query |
resourceType |
Unit or Line |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
boolean |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Internal Server error |
2.13. Properties-controller
Properties Controller
2.13.1. Get Property Details
GET /properties
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
productId |
productId |
integer (int64) |
Query |
routeDefinitionId |
routeDefinitionId |
integer (int64) |
Query |
segmentId |
segmentId |
integer (int64) |
Query |
workOrderId |
workOrderId |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, properties not available |
|
500 |
Internal Server Error |
|
503 |
Service Unavailable |
2.14. User-settings-controller
User Settings Controller
2.14.1. Create User settings for the logged in user
POST /v2/settings
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
204 |
No Content, Error retrieving created user settings |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
App ID not found in privilege set |
|
409 |
Conflict, User Setting already exists. Use a PUT to update |
|
500 |
Internal Server Error |
2.14.2. Get User settings for the logged in User
GET /v2/settings
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.14.3. Update User settings for the logged in user
PUT /v2/settings
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, There is no saved User settings for the logged in user |
|
500 |
Internal Server Error |
2.14.4. Delete User settings for the logged in user
DELETE /v2/settings
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
204 |
Success |
string |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, User Setting not found |
|
500 |
Internal Server Error |
2.14.5. Get Privilege Sets
GET /v2/settings/apps
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< PrivilegeSet > array |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
2.15. Work-order-component-controller
Work Order Component Controller
2.15.1. Add alot
POST /workOrders/{workOrderId}/addLots
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
workOrderId |
workOrderId |
integer (int64) |
Query |
status |
status |
string |
Body |
addLotEntry |
addLotEntry |
< AddLotEntry > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
201 |
Created |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
2.16. Work-order-socket-controller
Work Order Socket Controller
2.17. Work-queue-controller
Work Queue Controller
2.17.1. Get collection of operations by workorders.
GET /workqueue
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
userSettingsOn |
userSettingsOn |
boolean |
|
Query |
workOrderId |
Accept comma seperated workOrderIds - Ex:1000, 1001, 1002 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< WorkQueue > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.2. Check a work order and operation’s materialLotActuals eligible to complete.
POST /workqueue/checkEnableComplete
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.3. Complete multiple segmentActuals in a workorder.
POST /workqueue/complete
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< WorkQueue > array |
400 |
Bad Request. |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.4. Get a page of the operations collection.
GET /workqueue/operations
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
equipmentId |
equipmentId |
integer (int64) |
|
Query |
materialLotIdentifier |
materialLotIdentifier |
string |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
producedMaterialId |
producedMaterialId |
integer (int64) |
|
Query |
segmentId |
segmentId |
< integer (int64) > array(multi) |
|
Query |
segmentName |
segmentName |
string |
|
Query |
size |
Number of records per page. |
integer (int32) |
|
Query |
workOrderId |
workOrderId |
integer (int64) |
|
Query |
workOrderName |
workOrderName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.5. Get clocked on and assigned operations collection.
GET /workqueue/queue
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.6. RecordQuantity a serialLot operation
POST /workqueue/recordQuantity
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request. |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.7. Get the operations collection by workOrderName or serialNumber or operationName or lotIdentifier.
GET /workqueue/search
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
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 |
< WorkQueue > array |
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
UnProcessable Entity |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
2.17.8. To get unconsumed BOM count in a segment/operation
POST /workqueue/unConsumedBomCount
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server error |
|
503 |
Service Unavailable |
3. Definitions
3.1. ActivityVariableCounts
| Name | Schema |
|---|---|
activityId |
integer (int64) |
eventId |
integer (int64) |
eventType |
enum (TimeBasedEvent, ProductionEvent, UserDefinedEvent, ProductChangeEvent) |
remainingMandatoryVariablesCount |
integer (int32) |
segmentActualId |
integer (int64) |
totalMandatoryVariablesCount |
integer (int32) |
totalVariablesCount |
integer (int32) |
3.2. ActivityVariablesRequest
| Name | Description | Schema |
|---|---|---|
operationName |
operationName of the workorder record |
string |
segmentActualActivtyEntries |
segmentActualActivtyEntries details of the Operation |
< SegmentActualActivtyRequest > array |
segmentId |
segmentId of the workorder record |
integer (int64) |
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.3. ActivityVariablesResponse
| Name | Schema |
|---|---|
segmentActualActivtyResponses |
< SegmentActualActivtyResponse > array |
segmentId |
integer (int64) |
workOrderId |
integer (int64) |
3.4. AddLotEntry
Material lot information used by the add lot command to identify the material lot identifiers and their planned quantity.
| Name | Description | Schema |
|---|---|---|
lotIdentifier |
Identifier for this material lot |
string |
plannedQuantity |
The planned quantity to produce with this material lot. |
integer (int32) |
3.5. ApplicationTabDetailResponse
| Name | Schema |
|---|---|
description |
string |
display_name |
string |
id |
integer (int64) |
standard |
boolean |
tab_config_data |
|
tab_config_expressions |
3.6. ApplicationTabResponseResource
| Name | Schema |
|---|---|
description |
string |
displayName |
string |
enabled |
boolean |
id |
integer (int64) |
links |
|
sequenceOrder |
integer (int32) |
standard |
boolean |
3.7. ApplicationTabResponseResults
| Name | Schema |
|---|---|
content |
< ApplicationTabResponseResource > array |
links |
|
page |
3.9. BomConsumptionRecordDetails
| Name | Description | Schema |
|---|---|---|
bomRequiredForConsumption |
boolean |
|
itemConsumptionRecords |
BOM Item Consumed records |
< ItemConsumptionRecord > array |
totalConsumedQuantity |
Total Consumed Quantity |
number |
totalConsumedQuantityRaw |
Total Consumed Raw Quantity |
number |
3.10. BomCountRequest
| Name | Description | Schema |
|---|---|---|
isHeaderCount |
isHeaderCount check the Bom count is for header |
boolean |
processOrderId |
processOrderId of the workorder record |
integer (int64) |
productId |
productId of the workorder record |
integer (int64) |
segmentActuals |
< SegmentActual > array |
|
segmentId |
segmentId of the workorder record |
integer (int64) |
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.11. BomCountResponse
| Name | Schema |
|---|---|
bomTotalCount |
integer (int64) |
segmentActualBomCount |
< SegmentActualBomCount > array |
segmentId |
integer (int64) |
workOrderId |
integer (int64) |
3.12. BomMaterialLotInfo
| Name | Schema |
|---|---|
availableForConsumption |
boolean |
currentQuantity |
number (float) |
dimension |
string |
dimensionName |
string |
dimensionalQuantities |
< DimensionalQuantity > array |
id |
integer (int64) |
initialQuantity |
number (double) |
lotIdentifier |
string |
processOrderId |
integer (int64) |
productId |
integer (int64) |
statusId |
integer (int64) |
timeStamp |
string (date-time) |
unitId |
integer (int64) |
unitName |
string |
unitOfMeasureId |
integer (int64) |
userId |
integer (int64) |
validStatusBasedOnRawMaterialInputConfig |
boolean |
validUOMBasedOnBomItemConfig |
boolean |
validUnitForConsumption |
boolean |
3.13. BomResponse
| Name | Schema |
|---|---|
isLastOperation |
boolean |
mesServiceAvailable |
boolean |
plannedLineId |
integer (int32) |
routeBillOfMaterials |
< object > array |
schemaVersion |
integer (int32) |
segmentBillOfMaterials |
< object > array |
3.14. ClockEntry
| Name | Description | Schema |
|---|---|---|
laborTypeId |
Suggested labor type id |
integer (int64) |
segmentActualId |
segmentActualId id of the workorder |
integer (int64) |
segmentId |
segmentId id of the workorder |
integer (int64) |
status |
status of the lot record |
string |
unitId |
unitId of the workorder |
integer (int64) |
3.15. ClockOnRecord
| Name | Schema |
|---|---|
clockOffTime |
string (date-time) |
clockOnTime |
string (date-time) |
clockedOn |
boolean |
id |
integer (int64) |
laborTypeId |
integer (int64) |
loggedInUser |
boolean |
operator |
string |
3.16. ClockRequest
| Name | Description | Schema |
|---|---|---|
clockEntries |
< ClockEntry > array |
|
clockedOn |
Is clocked on of the record |
boolean |
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.17. CommonBomLotCreateAndConsumeRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID, required for createAndConsume as well as just consume |
integer (int64) |
initialQuantity |
Initial Quantity of LOT, required for just createAndConsume. This is the initialQuantity with which the new source lot will be created if a new source lot is required. |
number (double) |
lotIdentifier |
New Material Lot Identifier, required for just createAndConsume. In case create is required, sourceMaterialLotId will be null and no existing lots are there. A lot will be created with this name |
string |
productId |
ProductId / Applied ProductId of new LOT, required for just createAndConsume. This the product on which new source lot will be created if a new source lot is required. |
integer (int64) |
quantityToConsume |
quantityToConsume, required for createAndConsume as well as just consume |
number (double) |
segmentId |
Segment ID, it is valid for work order only |
integer (int64) |
sourceLotUnitId |
Unit Id of the source lot to create the lot on, required for just createAndConsume. This is the unit on which new source lot will be created if a new source lot is required. |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID, required for just consume. This the existing lot from which consumption will be done |
integer (int64) |
targetLotUnitId |
Target material Lot Unit ID, required for createAndConsume as well as just consume. This will be used to check consume permission on the target Lot |
integer (int64) |
targetMaterialLotId |
Target material Lot ID, required for createAndConsume as well as just consume. This is the lot against which consumtion will be done |
integer (int64) |
unitOfMeasureId |
Unit of Measure ID of the bom item, required for createAndConsume as well as just consume |
integer (int64) |
workOrderId |
Work Order ID, it is valid for work order only |
integer (int64) |
3.19. CompleteRequest
| Name | Description | Schema |
|---|---|---|
isSerialized |
Product is Serialized/Non-Serialized |
boolean |
materialLotActualId |
materialLotActualId id of the workorder |
integer (int64) |
onHold |
Operation on Hold |
boolean |
requiresClockOn |
Operation requires clockOn |
boolean |
segmentActualId |
segmentActualId id of the workorder |
integer (int64) |
segmentId |
SegmentId id of the workorder |
integer (int64) |
startedOnUnitId |
started On UnitId |
integer (int64) |
status |
Operation Status |
string |
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.20. CompleteRequestV2
| Name | Description | Schema |
|---|---|---|
isRecordCompleteTransaction |
Record Complete transaction of the operation |
boolean |
isSerialized |
Product is Serialized/Non-Serialized |
boolean |
nonClocking |
nonClocking of the Operation |
boolean |
operationName |
operationName of the workorder record |
string |
segmentActuals |
SegmentActuals id of the workorder |
< SegmentActualCompleteRequestV2 > array |
segmentId |
SegmentId of the workorder record |
integer (int64) |
workOrderId |
WorkorderId of the workorder record |
integer (int64) |
3.21. ConsumptionRecordInfo
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
entryOn |
Lot Entry On |
string (date-time) |
id |
Consumption Record ID / event component ID |
integer (int64) |
links |
< Link > array |
|
lotIdentifier |
Lot Identifier |
string |
productId |
Product ID / Applied Product ID |
integer (int64) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
timeStamp |
Lot Timestamp |
string (date-time) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
userId |
PA UserId |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.22. ConsumptionRecordRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
consumedQuantity |
Consumed Quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
sourceMaterialLotId |
Source Material Lot ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.23. DimensionalQuantity
| Name | Description | Schema |
|---|---|---|
currentQuantity |
Current Quantity of lot / Final Dimension |
number (float) |
dimension |
Dimension to which to which it belongs |
string |
dimensionName |
Dimension name of Subtype |
string |
initialQuantity |
Initial Quantity of lot for / Initial Dimension |
number (double) |
unitOfMeasureId |
Unit Of Measure ID |
integer (int64) |
3.24. Documents
| Name | Schema |
|---|---|
routeDocumentReferences |
< object > array |
segmentDocumentReferences |
< object > array |
3.26. ExternalConfigResponse
| Name | Description | Schema |
|---|---|---|
actionId |
integer (int64) |
|
actionName |
string |
|
actionType |
string |
|
actionTypeId |
integer (int64) |
|
configId |
integer (int64) |
|
createdBy |
string |
|
createdOn |
string |
|
data |
object |
|
deleted |
Example : |
boolean |
id |
integer (int64) |
|
lastModifiedOn |
string |
|
updatedBy |
string |
3.27. ExternalConfigResponsePage
| Name | Schema |
|---|---|
content |
< ExternalConfigResponse > array |
links |
|
page |
3.29. InputParamterRequest
| Name | Schema |
|---|---|
custom_property |
boolean |
input_mapping_key |
string |
input_parameter_data |
string |
input_parameter_id |
integer (int64) |
input_parameter_value |
string |
property_definition_id |
string |
property_definition_initial_id |
string |
property_definition_initial_value |
string |
property_group_id |
string |
3.30. ItemConsumptionRecord
| Name | Description | Schema |
|---|---|---|
bomItemId |
bomItemId |
integer (int64) |
consumedQuantity |
consumedQuantity |
number (double) |
consumedQuantityRaw |
consumedQuantityRaw |
number (double) |
id |
Event components id |
integer (int64) |
lotIdentifier |
Source lotIdentifier |
string |
quantityPrecision |
quantityPrecision |
integer (int32) |
sourceMaterialLotId |
sourceMaterialLotId |
integer (int64) |
targetMaterialLotId |
targetMaterialLotId |
integer (int64) |
timeStamp |
Time stamp for the consumption |
string (date-time) |
unitOfMeasure |
Unit Of Measure of the BOM Item |
string |
unitOfMeasureId |
unitOfMeasureId |
integer (int64) |
userId |
User Id of the user who made the consumption |
integer (int64) |
userName |
User Name of the user who made the consumption |
string |
3.31. Link
| Name | Description | Schema |
|---|---|---|
deprecation |
string |
|
href |
string |
|
hreflang |
string |
|
media |
string |
|
name |
string |
|
profile |
string |
|
rel |
string |
|
template |
||
templated |
Example : |
boolean |
title |
string |
|
type |
string |
3.33. MaterialInfo
| Name | Schema |
|---|---|
description |
string |
productCode |
string |
productFamilyId |
integer (int64) |
productId |
integer (int64) |
3.34. MaterialLotActualRecord
| Name | Schema |
|---|---|
clockedOnRecords |
< ClockOnRecord > array |
completedBy |
string |
completedOn |
string (date-time) |
completedQuantity |
integer (int32) |
holdOn |
string (date-time) |
initialPlannedQuantity |
integer (int32) |
materialLotActualId |
integer (int64) |
materilLotActualName |
string |
materilLotActualStatus |
string |
oldPlannedQuantity |
integer (int32) |
onHold |
boolean |
onHoldBy |
string |
plannedQuantity |
integer (int32) |
productOverThreshold |
integer (int64) |
productUnderThreshold |
integer (int64) |
recordedQuantity |
integer (int32) |
remainingQuantity |
integer (int32) |
segmentActualId |
integer (int64) |
segmentActualStatus |
string |
skippedBy |
string |
skippedOnTime |
string (date-time) |
startedOn |
string (date-time) |
startedOnUnitId |
integer (int64) |
totalCompletedQuantity |
integer (int32) |
unreadiedBy |
string |
unreadiedOnTime |
string (date-time) |
3.35. MaterialLotConsumptionRequest
| Name | Description | Schema |
|---|---|---|
bomItemId |
Bom Item ID |
integer (int64) |
initialQuantity |
Initial Quantity of LOT |
number (double) |
lotIdentifier |
New Material Lot Identifier |
string |
productId |
ProductId / Applied ProductId of new LOT |
integer (int64) |
quantity |
Consumed Quantity |
number (double) |
segmentId |
Segment ID |
integer (int64) |
targetMaterialLotId |
Target material Lot ID |
integer (int64) |
unitId |
Unit Id |
integer (int64) |
unitOfMeasureId |
Unit of Measre ID |
integer (int64) |
workOrderId |
Work Order ID |
integer (int64) |
3.36. MaterialLotEnableCompleteRequest
| Name | Description | Schema |
|---|---|---|
flagType |
flagType of the Request |
integer (int32) |
operationName |
operationName of the workorder record |
string |
processOrderId |
processOrderId of the workorder record |
integer (int64) |
productId |
productId of the workorder record |
integer (int64) |
segmentActuals |
segmentActuals of te Operation |
< SegmentActual > array |
segmentId |
segmentId of the workorder record |
integer (int64) |
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.37. MaterialLotInfoResult
| Name | Description | Schema |
|---|---|---|
availableForConsumption |
Is Available For Consumption |
boolean |
currentQuantity |
Current Quantity of lot / Final Dimension X |
number (float) |
dimension |
Dimension to which to which it belongs |
string |
dimensionName |
Dimension name of Subtype |
string |
dimensionalQuantities |
Collection of Dimensional quantities A,X,Y,Z |
< DimensionalQuantity > array |
id |
Material Lot ID / Event ID |
integer (int64) |
initialQuantity |
Initial Quantity of lot / Initial Dimension X |
number (double) |
links |
< Link > array |
|
lotIdentifier |
Lot Identifier / Event Num |
string |
processOrderId |
ID of process order / pp_id |
integer (int64) |
productId |
Product ID / Applied Product ID |
integer (int64) |
statusId |
Lot status / Event Status |
integer (int64) |
timeStamp |
Time when the lot was created. |
string (date-time) |
unitId |
Unit ID / PU ID |
integer (int64) |
unitOfMeasureId |
Unit Of Measure ID |
integer (int64) |
userId |
UserId of the user who created the lot. |
integer (int64) |
3.38. MaterialLotInfoResults
| Name | Schema |
|---|---|
content |
< MaterialLotInfoResult > array |
links |
< Link > array |
page |
3.39. MaterialLotStatus
| Name | Description | Schema |
|---|---|---|
description |
MaterialLot Status Description |
string |
id |
MaterialLot Status ID / Event Status |
integer (int64) |
isGoodStatus |
Is Quality Good |
boolean |
isInventoryStatus |
Is Inventory |
boolean |
isProductionStatus |
Is Production |
boolean |
3.40. MaterialLotStatusResult
| Name | Description | Schema |
|---|---|---|
description |
MaterialLot Status Description |
string |
id |
MaterialLot Status ID / Event Status |
integer (int64) |
isGoodStatus |
Is Quality Good |
boolean |
isInventoryStatus |
Is Inventory |
boolean |
isProductionStatus |
Is Production |
boolean |
links |
< Link > array |
3.41. OperationDetails
| Name | Description | Schema |
|---|---|---|
actualEndDate |
actualEndDate of the work order |
string (date-time) |
actualStartDate |
actualStartDate of the work order |
string (date-time) |
allowAdditionOfMaterialLotToInProgressWorkOrder |
Allow AdditionOf MaterialLot To InProgress WorkOrder of the work order operation |
boolean |
allowManualSkip |
Allow ManualSkip Optional Operation of a workOrder |
boolean |
clockedOnRecords |
Clocked on users |
< ClockOnRecord > array |
completedBy |
Completed user |
string |
completedOn |
Completed Operation time |
string (date-time) |
createdBy |
Work order created user |
string |
defaultRecordQuantity |
defaultRecordQuantity flag of remaining quantity |
boolean |
holdOn |
OnHold Operation time |
string (date-time) |
isSerialized |
Product is Serialized/Non-Serialized |
boolean |
lotCompletedQuantity |
Lot Completed Quantity |
integer (int32) |
lotIdentifier |
LotIdentifier name of the workorder |
string |
lotInitialPlannedQuantity |
Lot Initial Planned Quantity |
integer (int32) |
lotPlannedQuantity |
Lot Planned Quantity |
integer (int32) |
lotRemainingQuantity |
Lot Remaining Quantity |
integer (int32) |
materialLotActualId |
LotIdentifier id of the workorder |
integer (int64) |
onHold |
On Hold state of the Operation |
boolean |
onHoldBy |
OnHold user |
string |
operationDesc |
Segment description of the work order |
string |
operationName |
Segment Identifier of the work order |
string |
plannedEndDate |
Work order planned end date |
string (date-time) |
plannedQuantity |
Work order planned quantity |
integer (int32) |
plannedStartDate |
Work order planned start date |
string (date-time) |
plannedUnitIds |
Operation planned on Units |
< integer (int64) > array |
processOrderId |
ProcessOrderId of work order |
integer (int64) |
productCode |
Product code of the workorder |
string |
productDesc |
Product Decription |
string |
productFamilyDesc |
Product family Description of the workorder |
string |
productFamilyId |
Product family id the workorder |
integer (int64) |
productId |
Product id of the workorder |
integer (int64) |
productOverThreshold |
Over Threshold value of a product |
integer (int32) |
productOverThresholdPercentage |
Over Threshold percentage of a product |
number (double) |
productUnderThreshold |
Under Threshold value of a product |
integer (int32) |
productUnderThresholdPercentage |
Under Threshold percentage of a product |
number (double) |
productionLineId |
Operation production line Id |
integer (int64) |
requiresClockOn |
NonClocking/Clocking Operation of a workOrder |
boolean |
routeDetails |
Route Object |
|
segmentActualId |
Segment actual id |
integer (int64) |
segmentId |
Segment id of the work order |
integer (int64) |
segmentStatus |
Segment status |
string |
skipIfSuccessorStarted |
Operation of a workOrder can be skipped |
boolean |
startedOn |
startedOn Operation time |
string (date-time) |
startedOnUnitId |
Operation Started on Unit |
integer (int64) |
suggestedLaborTypes |
Suggested labor types for the operation |
< integer (int32) > array |
workOrderId |
Id of work order |
integer (int64) |
workOrderName |
Name of the work order |
string |
workOrderPriority |
Priority of the work order |
integer (int32) |
workOrderStatus |
status of the work order |
string |
workorderAvailable |
Still available(not completed) quantity |
integer (int32) |
workorderCompleted |
Completed quantity of the work order |
integer (int32) |
workorderQuantity |
Total quantity of the work order |
integer (int32) |
3.42. OperationPage
| Name | Schema |
|---|---|
content |
< Operations > array |
links |
|
page |
3.43. Operations
| Name | Description | Schema |
|---|---|---|
actualEndDate |
actualEndDate of the work order |
string (date-time) |
actualStartDate |
actualStartDate of the work order |
string (date-time) |
allowManualSkip |
Allow ManualSkip Optional Operation of a workOrder |
boolean |
clockedOnRecords |
Clocked on users |
< ClockOnRecord > array |
completedBy |
Completed user |
string |
completedOn |
Completed Operation time |
string (date-time) |
holdOn |
OnHold Operation time |
string (date-time) |
isSerialized |
Product is Serialized/Non-Serialized |
boolean |
links |
||
lotCompletedQuantity |
Lot Completed Quantity |
integer (int32) |
lotIdentifier |
LotIdentifier name of the workorder |
string |
lotInitialPlannedQuantity |
Lot Initial Planned Quantity |
integer (int32) |
lotPlannedQuantity |
Lot Planned Quantity |
integer (int32) |
lotRemainingQuantity |
Lot Remaining Quantity |
integer (int32) |
materialLotActualId |
LotIdentifier id of the workorder |
integer (int64) |
onHold |
On Hold state of the Operation |
boolean |
onHoldBy |
OnHold user |
string |
operationDesc |
Segment description of the work order |
string |
operationName |
Segment Identifier of the work order |
string |
plannedEndDate |
plannedEndDate of the work order |
string (date-time) |
plannedQuantity |
Work order planned quantity |
integer (int32) |
plannedStartDate |
plannedStartDate of the work order |
string (date-time) |
plannedUnitIds |
Operation planned on Units |
< integer (int64) > array |
processOrderId |
ProcessOrderId of work order |
integer (int64) |
productCode |
Product code of the workorder |
string |
productDesc |
Product desc of the workorder |
string |
productFamilyDesc |
Product family Description of the workorder |
string |
productFamilyId |
Product family id the workorder |
integer (int64) |
productId |
Product id of the workorder |
integer (int64) |
productOverThreshold |
Over Threshold value of a product |
integer (int32) |
productOverThresholdPercentage |
Over Threshold percentage of a product |
number (double) |
productUnderThreshold |
Under Threshold value of a product |
integer (int32) |
productUnderThresholdPercentage |
Under Threshold percentage of a product |
number (double) |
productionLineId |
Operation production line Id |
integer (int64) |
requiresClockOn |
NonClocking/Clocking Operation of a workOrder |
boolean |
routeDetails |
Route Object |
|
segmentActualId |
Segment actual id |
integer (int64) |
segmentId |
Segment id of the work order |
integer (int64) |
segmentStatus |
Segment status |
string |
skipIfSuccessorStarted |
Operation of a workOrder can be skipped |
boolean |
startedOn |
startedOn Operation time |
string (date-time) |
startedOnUnitId |
Operation Started on Unit |
integer (int64) |
suggestedLaborTypes |
Suggested labor types for the operation |
< integer (int32) > array |
workOrderId |
Id of work order |
integer (int64) |
workOrderName |
Name of the work order |
string |
workOrderPriority |
Priority of the work order |
integer (int32) |
3.44. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.45. PrivilegeSet
| Name | Schema |
|---|---|
category |
string |
description |
string |
displayName |
string |
icon |
string |
id |
integer (int32) |
scope |
string |
3.46. ProductCustomProperty
| Name | Schema |
|---|---|
displayName |
string |
productId |
integer (int64) |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyDefinitionId |
string |
propertyGroupId |
string |
propertyGroupName |
string |
propertyName |
string |
propertyValue |
string |
required |
boolean |
uomCode |
string |
uomId |
integer (int32) |
3.47. ProductFamily
| Name | Description | Schema |
|---|---|---|
description |
The product family’s description |
string |
id |
The unique Id of the product family |
integer (int64) |
links |
< Link > array |
3.48. ProductFamilyPage
| Name | Schema |
|---|---|
content |
< ProductFamily > array |
links |
< Link > array |
page |
3.49. PropertiesResponse
| Name | Schema |
|---|---|
materialProperties |
< PropertyResponseMaterial > array |
routeLevelProperties |
< string, < PropertyResponse > array > map |
segmentProperties |
< string, < PropertyResponse > array > map |
3.50. PropertyResponse
| Name | Schema |
|---|---|
displayName |
string |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyDefinitionId |
string |
propertyGroupId |
string |
propertyGroupName |
string |
propertyName |
string |
propertyValue |
string |
required |
boolean |
segmentId |
integer (int64) |
uomCode |
string |
uomId |
integer (int32) |
3.51. PropertyResponseMaterial
| Name | Schema |
|---|---|
displayName |
string |
productId |
integer (int64) |
propertyCategoryId |
string |
propertyCategoryName |
string |
propertyDataType |
string |
propertyDataTypeId |
integer (int32) |
propertyDefinitionId |
string |
propertyGroupId |
string |
propertyGroupName |
string |
propertyName |
string |
propertyValue |
string |
required |
boolean |
uomCode |
string |
uomId |
integer (int32) |
3.52. RecordQuantityEntryRequest
| Name | Description | Schema |
|---|---|---|
recordQuantity |
RecordQuantity of a operation serailLot |
integer (int32) |
segmentActualId |
SegmentActualId of a operation serialLot |
integer (int64) |
status |
Status of the lot record |
string |
3.53. RecordQuantityEntryResponse
| Name | Description | Schema |
|---|---|---|
remainingQuantity |
RemainingQuantity of a operation serailLot |
integer (int32) |
segmentActualId |
SegmentActualId of a operation serialLot |
integer (int64) |
3.54. RecordQuantityRequest
| Name | Description | Schema |
|---|---|---|
completeLotIdentifer |
complete LotIdentifer of the Operation |
boolean |
recordQuantityEntries |
RecordQuantityEntries of the workorder operation |
< RecordQuantityEntryRequest > array |
segmentId |
SegmentId id of the workorder |
integer (int64) |
startedOnUnitId |
startedOnUnitId of the Operation |
integer (int64) |
workOrderId |
SorkorderId of the workorder record |
integer (int64) |
3.55. RecordQuantityResponse
| Name | Description | Schema |
|---|---|---|
recordQuantityEntryResponses |
recordQuantityEntryResponses of the workorder operation |
< RecordQuantityEntryResponse > array |
segmentId |
SegmentId id of the workorder |
integer (int64) |
workOrderId |
workOrderId of the workorder record |
integer (int64) |
3.56. RouteResponse
| Name | Description | Schema |
|---|---|---|
lastModifiedOn |
Route lastModifiedOn |
string (date-time) |
revision |
Route revision |
integer (int32) |
routeDefinitionId |
Route DefinitionId |
integer (int64) |
routeName |
Route name |
string |
3.57. SegmentActual
| Name | Description | Schema |
|---|---|---|
lotIdentifier |
lotIdentifier of materialLotActual |
string |
materialLotActualId |
materialLotActualId id of the SegmentActual |
integer (int64) |
plannedQuantity |
plannedQuantity of the Lot |
integer (int32) |
segmentActualId |
SegmentActualId id of the workorder |
integer (int64) |
startedOnUnitId |
startedOnUnitId of the Operation |
integer (int64) |
3.58. SegmentActualActivityVariableResponse
| Name | Schema |
|---|---|
activityId |
integer (int64) |
remainingMandatoryVariablesCount |
integer (int32) |
3.59. SegmentActualActivtyRequest
| Name | Description | Schema |
|---|---|---|
clockedOn |
clocked on of the activity record |
boolean |
lotIdentifier |
lotIdentifier of materialLotActual |
string |
materialLotActualId |
materialLotActualId id of the SegmentActual |
integer (int64) |
segmentActualId |
SegmentActualId id of the workorder |
integer (int64) |
startedOnUnitId |
startedOnUnitId of the Operation |
integer (int64) |
3.60. SegmentActualActivtyResponse
| Name | Schema |
|---|---|
activities |
< SegmentActualActivityVariableResponse > array |
segmentActualId |
integer (int64) |
3.61. SegmentActualBomCount
| Name | Schema |
|---|---|
bomCount |
integer (int64) |
segmentActualId |
integer (int64) |
3.62. SegmentActualCompleteRequestV2
| Name | Description | Schema |
|---|---|---|
completedQuantity |
completedQuantity of the Operation lot |
integer (int32) |
lotIdentifier |
lotIdentifier of materialLotActual |
string |
lotInitialPlannedQuantity |
lotInitialPlannedQuantity of the Operation lot |
integer (int32) |
materialLotActualId |
materialLotActualId id of the workorder |
integer (int64) |
plannedQuantity |
plannedQuantity of the Operation lot |
integer (int32) |
segmentActualId |
segmentActualId id of the workorder |
integer (int64) |
segmentActualStatus |
segmentActualStatus of the lot record |
string |
startedOnUnitId |
startedOnUnitId of the Operation |
integer (int64) |
3.63. SkipRecordEntry
| Name | Description | Schema |
|---|---|---|
segmentActualId |
SegmentActualId id of the workorder |
integer (int64) |
startedOnUnitId |
started On UnitId |
integer (int64) |
status |
Status of the lot record |
string |
3.64. SkipRequest
| Name | Description | Schema |
|---|---|---|
segmentId |
segmentId of the workorder record |
integer (int64) |
skipEntries |
< SkipRecordEntry > array |
|
workOrderId |
workorderId of the workorder record |
integer (int64) |
3.65. TabConfigData
| Name | Schema |
|---|---|
authentication |
boolean |
enable_seriallot |
boolean |
external_url |
string |
tab_input_parameters |
< InputParamterRequest > array |
3.67. TemplateVariable
| Name | Schema |
|---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.69. UnitInfo
| Name | Schema |
|---|---|
line |
string |
lineId |
integer (int64) |
unit |
string |
unitId |
integer (int64) |
validStatuses |
< MaterialLotStatusResult > array |
3.70. UnitsData
| Name | Description | Schema |
|---|---|---|
assetId |
The assetId of the unit |
integer (int64) |
lineId |
The lineId of the unit |
integer (int64) |
lineName |
The line name of the unit |
string |
name |
The name of the unit |
string |
3.71. UriTemplate
| Name | Schema |
|---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.72. UserSettingRequest
| Name | Description | Schema |
|---|---|---|
appId |
integer (int32) |
|
data |
The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} } |
object |
viewName |
string |
3.73. UserSettingResponseResource
| Name | Description | Schema |
|---|---|---|
appId |
integer (int32) |
|
data |
object |
|
defaultSetting |
Example : |
boolean |
links |
< Link > array |
|
viewName |
string |
3.74. WorkOrder
Work order Data transfer object
| Name | Description | Schema |
|---|---|---|
cancelledOn |
Date that the work order was cancelled. |
string (date-time) |
completedBy |
The user that completed the work order. |
string |
completedOn |
Date that the work order was completed. |
string (date-time) |
createdBy |
User that created the work order. |
string |
createdOn |
Date that the work order was created. |
string (date-time) |
eTagValue |
Current ETag value of the work order resource |
string |
id |
Work Order ID. |
integer (int64) |
lastModifiedBy |
User that last modified the work order. |
string |
lastModifiedOn |
Date that the work order was last modified. |
string (date-time) |
name |
Work Order name. |
string |
plannedEndDate |
Planned end date for the work order. |
string (date-time) |
plannedQuantity |
The planned quantity to produce with this work order. |
integer (int32) |
plannedStartDate |
Planned start date for the work order. |
string (date-time) |
priority |
Relative priority of the work order. |
integer (int32) |
processOrderId |
Work order’s process order in the plant apps execution system. |
integer (int64) |
producedMaterialId |
Work order produced material ID. |
integer (int64) |
productionLineId |
Work order production line ID. |
integer (int64) |
readyOn |
Date that the work order was made ready. |
string (date-time) |
routeDefinitionId |
Refers to the route used to execute the work order. |
integer (int64) |
startedOn |
Date that the work order was started. |
string (date-time) |
status |
Status of the work order. |
string |
3.75. WorkQueue
| Name | Description | Schema |
|---|---|---|
actualEndDate |
actualEndDate of the work order |
string (date-time) |
actualStartDate |
actualStartDate of the work order |
string (date-time) |
allowAdditionOfMaterialLotToInProgressWorkOrder |
Allow AdditionOf MaterialLot To InProgress WorkOrder of the work order operation |
boolean |
allowManualSkip |
Allow ManualSkip Optional Operation of a workOrder |
boolean |
appliesTo |
appliesTo of the work order operation |
|
assignedToUser |
user assigned operations |
boolean |
completedOn |
completedOnDate of the work order |
string (date-time) |
defaultRecordQuantity |
defaultRecordQuantity of the work order operation |
boolean |
id |
integer (int64) |
|
materialLotActualsRecords |
materialLotActuals on a workOrder |
< MaterialLotActualRecord > array |
operationDesc |
Segment description of the work order |
string |
operationName |
Segment Identifier of the work order |
string |
plannedEndDate |
plannedEndDate of the work order |
string (date-time) |
plannedQuantity |
Planned Quantity of the work order |
integer (int32) |
plannedStartDate |
plannedStartDate of the work order |
string (date-time) |
plannedUnitIds |
Operation planned on Unit Ids |
< integer (int64) > array |
plannedUnits |
Operation planned on Units |
< UnitsData > array |
processOrderId |
processOrderId of the work order |
integer (int64) |
productCode |
Product id of the workorder |
string |
productDesc |
Product desc of the workorder |
string |
productFamilyDesc |
ProductFamily desc of the workorder |
string |
productId |
Product id of the workorder |
integer (int64) |
productIsSerialized |
Product isSerialized of the workorder |
boolean |
productOverThresholdPercentage |
number (double) |
|
productUnderThresholdPercentage |
number (double) |
|
productionLineId |
productionLineId of the work order |
integer (int64) |
requiresClockOn |
requiresClockOn of the work order operation |
boolean |
routeDetails |
Route Object |
|
segmentId |
Segment id of the work order |
integer (int64) |
segmentStatus |
Segment status |
string |
skipIfSuccessorStarted |
Operation of a workOrder can be skipped |
boolean |
startedOn |
startedOnDate of the work order |
string (date-time) |
startedOnUnitId |
startedOnUnitId of the operation |
integer (int64) |
suggestedLaborTypes |
suggestedLaborTypes |
< integer (int32) > array |
workOrderId |
Id of work order |
integer (int64) |
workOrderName |
Name of the work order |
string |
workOrderPriority |
Priority of the work order |
integer (int32) |
workOrderStatus |
status of the workorder |
string |
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. |