1. Overview

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

1.1. URI scheme

Host : localhost
BasePath : /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

  • operations-history-controller : Operations History Controller

  • operator-controller : Operator Controller

  • permission-check-controller : Permission Check Controller

  • properties-controller : Properties Controller

  • risk-release-controller : Risk Release Controller

  • tools-controller : Tools Controller

  • tools-usage-controller : Tools Usage 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

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

activityVariablesRequest
required

activityVariablesRequest

ActivityVariablesRequest
Responses
HTTP Code Description Schema

200

OK

object

202

Accepted

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.2. Fetches List of activities containing their variable counts

GET /activities/activityVariableCounts
Caution

operation.deprecated
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

eventInfo
optional

Accept List of materialLotActualId and segmentActualId respectively with comma seperated - Ex:146:252,181:333

string

Query

eventType
optional

Type of eventNumbers provided above [all the eventIds should belong to same type]

enum (UserDefinedEvent)
Responses
HTTP Code Description Schema

200

OK

ActivityVariableCounts

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.3. activties

GET /activities/ids
Caution

operation.deprecated
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

materialLotActualId
required

materialLotActualId

integer (int64)

Query

segmentActualId
required

segmentActualId

integer (int64)

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ActivityVariablesResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.4. To check form is Custom form

GET /activities/isCustomform
Caution

operation.deprecated
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

materialLotActualId
required

materialLotActualId

integer (int64)

Query

segmentActualId
required

segmentActualId

integer (int64)

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.5. getVariableDetailsWithSpecs

GET /activities/outOfSpecsVariablesDetails
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

eventIds
optional

List of User Defined Event Ids to get variable details with Specs.

< integer (int64) > array(multi)

Query

segmentActualIds
optional

List of Segment Actual Ids to get variable details with Specs.

< integer (int64) > array(multi)

Query

workOrderId
optional

Work Order Id to get variable details with Specs.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< VariableDetailsWithSpecs > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

appId
required

appId

integer (int64)

Query

enabled
optional

enabled

boolean

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

< ApplicationTabResponseResults > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Get tab details mapped to appId

GET /apps/{appId}/tabs/{tabId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

appId
required

appId

integer (int64)

Path

tabId
required

tabId

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ApplicationTabDetailResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomItemId
required

bomItemId

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

sourceLotId
required

sourceLotId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ConsumptionRecordInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Common-bom-controller

Common Bom Controller

2.4.1. Get Permission on a resource

GET /api/checkPermission
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

permissionName
required

permissionName

string

Query

resourceId
required

ResourceId

integer (int64)

Query

resourceType
required

Resource Type

string
Responses
HTTP Code Description Schema

200

OK

boolean

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

entityId
required

Id of the entity for which

integer (int64)

Query

entityType
optional

entityType

enum (PRODUCT, BOMFORMULATION, BOMFORMULATIONITEM)

"Product"
Responses
HTTP Code Description Schema

200

OK

< ProductCustomProperty > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, properties not available

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomItemStorageUnitId
optional

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
required

Bom Item Engineering Unit Id

integer (int64)

Query

processOrderId
optional

processOrderId is used to check the RawMaterialInput Source Units configuration, if not provided then this check will be ignored

integer (int64)

Query

productId
required

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

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

No Content

503

Service Unavailable

No Content
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.4. consume Lot

POST /api/lot/consume
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

createLot
required

whether to create lot as well, defaults to true

boolean

"true"

Body

lotCreateAndConsumeRequest
required

Body for creation of source lot and consumption operation

CommonBomLotCreateAndConsumeRequest
Responses
HTTP Code Description Schema

200

Ok

ConsumptionRecordInfo

201

Created

ConsumptionRecordInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

  • application/vnd.ge.mes.v1.full+json

Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomItemId
optional

BOMFormualtion Item Id

integer (int64)

Query

bomItemStorageUnitId
optional

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
optional

BOM Item unit of measure Id to filter the lots with incorrect UOMId

integer (int64)

Query

filterCompletedReceiver
optional

Whether to filter material lots whose receivers are completed

boolean

"false"

Query

lotIdentifier
optional

lot identifier (use exact event_num/lot_identifier for this property)

string

Query

lotIdentifierPartialSearch
optional

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

"false"

Query

operationName
optional

OperationName of the work order

string

Query

orderType
optional

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
optional

processOrderId is used to check the RawMaterialInput Source Units configuration, if not provided then this check will be ignored

integer (int64)

Query

productId
optional

productId the lot which is being searched

integer (int64)

Query

requiredQuantity
optional

RequiredQuantity used to search lot and consumptions

number

0.0

Query

targetLotId
optional

Id of the targetLot

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< BomMaterialLotInfo > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.6. Consumption details for the item

GET /api/orders/{orderId}/bom/{itemId}/consumptions
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

itemId
required

bom itemId for which consumption history is required

integer (int64)

Path

orderId
required

order id, either work orderId or process order id

integer (int64)

Query

bomItemProductId
optional

Product Id of the bomItem.

integer (int64)

Query

bomItemQuantityPrecision
optional

QuantityPrecision of the bomItem.

integer (int32)

Query

bomItemStorageUnitId
optional

Storage Unit Id of the bomItem.

integer (int64)

Query

bomItemUnitOfMeasureId
optional

UnitOfMeasureId of the bomItem.

integer (int64)

Query

consumptionRecordId
optional

consumptionRecordId of the consumption operation.

integer (int64)

Query

orderType
required

orderType

enum (ProcessOrder, WorkOrder)

Query

segmentId
optional

segmentId

integer (int64)

Query

sourceMaterialLotId
optional

sourceMaterialLotId

integer (int64)

Query

targetLotId
optional

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
optional

totalRequiredQuantityToConsume used to calculate BomRequiredForConsumption

number (double)

0.0
Responses
HTTP Code Description Schema

200

Ok

BomConsumptionRecordDetails

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.7. Get MaterialLot Status by Id from product service

GET /api/statuses/{materialLotStatusId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotStatusId
required

MaterialLot Status ID To Get a MaterialLot Status Details.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialLotStatus > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.8. Get valid status transitions for a unit id

GET /api/v1/unitProductionStatus
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

inventoryType
optional

inventoryType

enum (IS_INVENTORY, ALL_INVENTORY)

"ALL_INVENTORY"

Query

unitId
required

unit id for which status transition is required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ProductionStatusTransitionResult > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.9. Get Custom Property Details for a given entity type and order type

GET /api/v2/orders/{orderId}/customProperties
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

orderId
required

Id of ProcessOrder or WorkOrder

integer (int64)

Query

entityId
required

Id of the entity whose properties needs to be fetched

integer (int64)

Query

entityType
required

Entity type of the entityId, it can be Product, BomFormulation or BomFormulationItem

enum (PRODUCT, BOMFORMULATION, BOMFORMULATIONITEM)

Query

fetchPropertiesFromDatabase
optional

Flag to fetch bom formulation properties from database or sdd, default is from sdd. For Work order it will be decided based on this flag value. For Process orders, properties would always be read from database and this flag is ignored.

boolean

"false"

Query

orderType
required

OrderType of the orderId, it can be ProcessOrder or WorkOrder

enum (ProcessOrder, WorkOrder)
Responses
HTTP Code Description Schema

200

OK

< EntityCustomProperty > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, properties not available

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.10. Get BOM Details for the process order

GET /api/{orderId}/boms
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

orderId
required

Id of ProcessOrder or WorkOrder.

integer (int64)

Query

fetchPropertiesFromDatabase
optional

Flag to fetch bom item properties from database or sdd, default is from sdd

boolean

"false"

Query

operationName
optional

OperationName of the work order

string

Query

orderType
required

OrderType of the orderId, it can be ProcessOrder or WorkOrder

enum (ProcessOrder, WorkOrder)

Query

plannedQuantity
optional

Relevant only if ordertype is WorkOrder. Default Value is 1

integer (int32)

1

Query

segmentId
optional

segmentId, Relevant only if ordertype is WorkOrder.

integer (int64)

Query

targetLotId
optional

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

BomResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5. Consumption-operations-controller

Consumption Operations Controller

2.5.1. Create a consumption record

POST /consumptionOperations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

resourceId
optional

EntityModel id to validate the permission forconsumption.

integer (int64)

Query

resourceType
optional

EntityModel Type to validate the permission forconsumption.

string

Body

consumptionRecord
required

consumptionRecord

ConsumptionRecordRequest
Responses
HTTP Code Description Schema

201

OK

ConsumptionRecordInfo

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.2. Get Consumption lots

GET /consumptionOperations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomItemId
optional

Consumption records for bomItemId.

integer (int64)

Query

id
optional

ID of consumption record / Component_Id of event_components.

integer (int64)

Query

quantityPrecision
optional

quantityPrecision

integer (int32)

4

Query

quantityRaw
optional

quantityRaw

number (double)

0.0

Query

segmentId
optional

Consumption records for segmentId.

integer (int64)

Query

sourceMaterialLotId
optional

Source Material Lot ID the product being consumed.

integer (int64)

Query

targetMaterialLotId
optional

Target material Lot ID the product being manufactured.

integer (int64)

Query

workOrderId
optional

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

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

No Content

503

Service Unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.3. Create lot and consume that Lot

POST /consumptionOperations/materialLot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

resourceId
optional

EntityModel id to validate the permission forconsumption.

integer (int64)

Query

resourceType
optional

EntityModel Type to validate the permission forconsumption.

string

Body

materialLotConsumptionRequest
required

materialLotConsumptionRequest

MaterialLotConsumptionRequest
Responses
HTTP Code Description Schema

201

Created

ConsumptionRecordRequest

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. Document-management-controller

Document Management Controller

2.6.1. Get document

GET /documents/attachment
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

attachmentName
required

attachment Name

string

Query

documentId
required

document id

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

500

Internal server error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7. Engineering-unit-controller

Engineering Unit Controller

2.7.1. Get All Units By ProductId

GET /engineeringunits
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

engineeringUnitId
optional

engineeringUnitId

integer (int64)

Query

productId
required

productId

string

Query

unitId
optional

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8. External-config-controller

External Config Controller

2.8.1. Get Configurations

GET /v1/configurations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

actionId
optional

actionId

integer (int32)

Query

actionName
optional

actionName

string

Query

actionTypeId
optional

actionTypeId

integer (int32)

Query

configId
optional

configId

integer (int64)

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

segmentId
optional

segmentId

integer (int64)

Query

size
optional

size

integer (int32)

20

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ExternalConfigResponsePage

204

No Content, Error retrieving actions

HttpErrorResponse

401

User Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9. Labor-type-controller

Labor Type Controller

2.9.1. getLaborTypes

GET /laborTypes
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< integer (int64) > array

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10. Material-controller

Material Controller

2.10.1. Get all the materials

GET /materials
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< MaterialInfo > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.2. Get list of materialLots and their properties

GET /materials/materialLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

lotIdentifier
required

lot identifier (use event_num/lot_identifier for this property at this time)

string

Query

productId
optional

Product ID (applied product id) to retrieve properties of materialLots.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialInfo > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.3. Get product families

GET /materials/productFamilies
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

page

integer (int32)

Query

productId
optional

productId

integer (int64)

Query

size
optional

size

integer (int32)
Responses
HTTP Code Description Schema

200

OK

< ProductFamilyPage > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10.4. Get MaterialLot Status by Id from product service

GET /materials/statuses/{materialLotStatusId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotStatusId
required

MaterialLot Status ID To Get a MaterialLot Status.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialLotStatus > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11. Operations-history-controller

Operations History Controller

2.11.1. Operations History details

GET /operationsHistory
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

materialLotActualId
required

materialLotActualId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

OperationDetails

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12. Operator-controller

Operator Controller

2.12.1. Query Operations

GET /operations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

clockedOn
optional

clockedOn

boolean

Query

completedAfter
optional

completedAfter

string

Query

completedBefore
optional

completedBefore

string

Query

equipmentId
optional

equipmentId

< integer (int64) > array(multi)

Query

isCustomDate
optional

isCustomDate

boolean

Query

limitSearchResult
optional

limitSearchResult

boolean

"false"

Query

materialLotIdentifier
optional

materialLotIdentifier

string

Query

onHold
optional

onHold

boolean

Query

operationName
optional

operationName

string

Query

orderBy
optional

orderBy

string

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

producedMaterialId
optional

producedMaterialId

< integer (int64) > array(multi)

Query

productFamilyId
optional

productFamilyId

< integer (int64) > array(multi)

Query

size
optional

Number of records per page.

integer (int32)

0

Query

status
optional

status

< string > array(multi)

Query

workOrderId
optional

workOrderId

integer (int64)

Query

workOrderName
optional

workOrderName

string
Responses
HTTP Code Description Schema

200

OK

OperationPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.2. Get the BOMs of particular oparation by work Order ID and segment ID

GET /operations/boms
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

plannedQuantity
optional

Lot plannedQuantity

integer (int64)

Query

segmentId
optional

Id of the segment resource

integer (int64)

Query

targetLotId
optional

Target lot Id of the segment consumed lot

integer (int64)

Query

workOrderId
required

Id of the work order resource

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BomResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.3. Clock on/off an operation

POST /operations/clock
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

ClockRequest
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.4. Complete of an operation

POST /operations/complete
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

CompleteRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.5. fetchTargetMaterialLotId

GET /operations/materialLotActuals/{materialLotActualId}/targetMaterialLot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotActualId
required

materialLotActualId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.6. Operation details

GET /operations/segmentActuals/{segmentActualId}/details
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

segmentActualId
required

segmentActualId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

OperationDetails

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.7. fetchTargetMaterialLot

GET /operations/segmentActuals/{segmentActualId}/targetMaterialLot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

segmentActualId
required

segmentActualId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.8. To get unconsumed BOM count in a segment/operation

GET /operations/segmentActuals/{segmentActualId}/unConsumedBomCount
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

segmentActualId
required

segmentActualId

integer (int64)

Query

plannedQuantity
optional

plannedQuantity

integer (int32)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

CompleteOpStatus

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.9. Documents of an operation

GET /operations/segments/{segmentId}/documents
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

segmentId
required

segmentId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Documents

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.10. Skip an operation

POST /operations/skip
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

SkipRequest
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.11. Start an operation

POST /operations/start
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

StartRequest
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.12. Units of all lines

GET /operations/units
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< UnitsData > array

401

Unauthorized

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12.13. Operation

GET /operations/{segmentActualId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

segmentActualId
required

segmentActualId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Operations

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13. Permission-check-controller

Permission Check Controller

2.13.1. checkPermission

GET /checkPermission
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

permissionName
required

Permission Scope

string

Query

resourceId
required

UnitId or LineId

integer (int32)

Query

resourceType
required

Unit or Line

string
Responses
HTTP Code Description Schema

200

OK

boolean

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14. Properties-controller

Properties Controller

2.14.1. Get Property Details

GET /properties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

productId
optional

productId

integer (int64)

Query

routeDefinitionId
optional

routeDefinitionId

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

PropertiesResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, properties not available

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.2. Get PropertyDefinitions Metadata from property definitionIds

GET /properties/propertyDefinitionDetails
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

propertyDefinitionIds
required

List of propertiesDefinitionIds whose metadata like propertyName, DataType etc, are required.

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.3. Get propertyDefinitions of the BomItemImport group

GET /properties/v1/propertyDefinitions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

PropertyDefinitionsPage

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15. Risk-release-controller

Risk Release Controller

2.15.1. Check Risk Release

GET /riskRelease/checkRiskRelease
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

materialLotId
optional

Material Lot Ids to check Risk Release

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

< MaterialLotRiskReleaseStatus > array

400

Unauthorized

HttpErrorResponse

401

Forbidden

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Forbidden

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15.2. createDefects

POST /riskRelease/createDefects
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

defect
optional

Defect details to create.

RiskReleaseDefectDTO
Responses
HTTP Code Description Schema

201

Success

object

400

ERRCD400: Invalid data supplied. See message for details.

No Content

401

ERR401: Unauthorized

No Content

404

ERRCD404: Non-conformance not found

No Content

500

ERR500: Internal Server Error

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16. Tools-controller

Tools Controller

2.16.1. Get Tools info

GET /toolsHistory/getToolsinfo
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

segmentId
optional

segmentId

integer (int64)

Query

variableId
optional

variableId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

HttpErrorResponse

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17. Tools-usage-controller

Tools Usage Controller

2.17.1. Get tool usage details at operation level

GET /tool/v1/toolUsage/getToolUsageDetailsAtOperationLevel
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

segmentActualId
required

segmentActualId

integer (int64)

Query

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17.2. Update tool usage details

POST /tool/v1/toolUsage/updateToolUsage
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

updateToolUsageRequest
required

updateToolUsageRequest

UpdateToolUsageRequest
Responses
HTTP Code Description Schema

200

Success

< ToolUsageResponse > array

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18. User-settings-controller

User Settings Controller

2.18.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

userSettingsRequest
required

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResponseResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

string

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.5. Get Privilege Sets

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19. Work-order-component-controller

Work Order Component Controller

2.19.1. Add alot

POST /workOrders/{workOrderId}/addLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

workOrderId
required

workOrderId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object

Query

status
required

status

string

Body

addLotEntry
required

addLotEntry

< AddLotEntry > array
Responses
HTTP Code Description Schema

200

OK

object

201

Created

WorkOrder

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20. Work-order-socket-controller

Work Order Socket Controller

2.20.1. workOrderSessions

GET /workorders.sessions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

object
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21. Work-queue-controller

Work Queue Controller

2.21.1. Get collection of operations by workorders.

GET /workqueue
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

20

Query

userSettingsOn
optional

userSettingsOn

boolean

Query

workOrderId
optional

Accept comma seperated workOrderIds - Ex:1000, 1001, 1002

string
Responses
HTTP Code Description Schema

200

OK

< WorkQueue > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.2. Check a work order and operation’s materialLotActuals eligible to complete.

POST /workqueue/checkEnableComplete
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

MaterialLotEnableCompleteRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.3. Complete multiple segmentActuals in a workorder.

POST /workqueue/complete
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

CompleteRequestV2
Responses
HTTP Code Description Schema

200

OK

< WorkQueue > array

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

CompleteRequestV2

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.4. Get a page of the operations collection.

GET /workqueue/operations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

equipmentId
optional

equipmentId

integer (int64)

Query

materialLotIdentifier
optional

materialLotIdentifier

string

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

producedMaterialId
optional

producedMaterialId

integer (int64)

Query

segmentId
optional

segmentId

< integer (int64) > array(multi)

Query

segmentName
optional

segmentName

string

Query

size
optional

Number of records per page.

integer (int32)

20

Query

workOrderId
optional

workOrderId

integer (int64)

Query

workOrderName
optional

workOrderName

string
Responses
HTTP Code Description Schema

200

OK

WorkQueue

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.5. Get clocked on and assigned operations collection.

GET /workqueue/queue
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

WorkQueue

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.6. RecordQuantity a serialLot operation

POST /workqueue/recordQuantity
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

request

RecordQuantityRequest
Responses
HTTP Code Description Schema

200

Success

RecordQuantityResponse

400

Bad Request.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.7. Get the operations collection by workOrderName or serialNumber or operationName or lotIdentifier.

GET /workqueue/search
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

name
required

name

string

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

< WorkQueue > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

UnProcessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.8. To get unconsumed BOM count in a segment/operation

POST /workqueue/unConsumedBomCount
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomCountRequest
required

bomCountRequest

BomCountRequest
Responses
HTTP Code Description Schema

200

OK

BomCountResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. ActivityVariableCounts

Name Schema

activityId
optional

integer (int64)

eventId
optional

integer (int64)

eventType
optional

enum (TimeBasedEvent, ProductionEvent, UserDefinedEvent, ProductChangeEvent)

remainingMandatoryVariablesCount
optional

integer (int32)

segmentActualId
optional

integer (int64)

totalMandatoryVariablesCount
optional

integer (int32)

totalVariablesCount
optional

integer (int32)

3.2. ActivityVariablesRequest

Name Description Schema

operationName
optional

operationName of the workorder record

string

segmentActualActivtyEntries
optional

segmentActualActivtyEntries details of the Operation

< SegmentActualActivtyRequest > array

segmentId
optional

segmentId of the workorder record

integer (int64)

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.3. ActivityVariablesResponse

Name Schema

segmentActualActivtyResponses
optional

< SegmentActualActivtyResponse > array

segmentId
optional

integer (int64)

workOrderId
optional

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
required

Identifier for this material lot

string

plannedQuantity
required

The planned quantity to produce with this material lot.

integer (int32)

3.5. ApplicationTabDetailResponse

Name Schema

description
optional

string

display_name
optional

string

id
optional

integer (int64)

standard
optional

boolean

tab_config_data
optional

TabConfigData

tab_config_expressions
optional

TabConfigExpressions

3.6. ApplicationTabResponseResource

Name Schema

description
optional

string

displayName
optional

string

enabled
optional

boolean

id
optional

integer (int64)

links
optional

Links

sequenceOrder
optional

integer (int32)

standard
optional

boolean

3.7. ApplicationTabResponseResults

Name Schema

content
optional

< ApplicationTabResponseResource > array

links
optional

Links

page
optional

PageMetadata

3.8. AppliesTo

Name Schema

materialLotActualIds
optional

< integer (int64) > array

3.9. BomConsumptionRecordDetails

Name Description Schema

bomRequiredForConsumption
optional

boolean

itemConsumptionRecords
optional

BOM Item Consumed records

< ItemConsumptionRecord > array

totalConsumedQuantity
optional

Total Consumed Quantity

number

totalConsumedQuantityRaw
optional

Total Consumed Raw Quantity

number

3.10. BomCountRequest

Name Description Schema

isHeaderCount
optional

isHeaderCount check the Bom count is for header

boolean

processOrderId
optional

processOrderId of the workorder record

integer (int64)

productId
optional

productId of the workorder record

integer (int64)

segmentActuals
optional

< SegmentActual > array

segmentId
optional

segmentId of the workorder record

integer (int64)

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.11. BomCountResponse

Name Schema

bomTotalCount
optional

integer (int64)

segmentActualBomCount
optional

< SegmentActualBomCount > array

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.12. BomItem

Name Schema

bomItemId
optional

integer (int64)

bomReallocationQuantity
optional

< integer (int64) > array

3.13. BomMaterialLotInfo

Name Description Schema

availableForConsumption
optional

boolean

currentQuantity
optional

number (float)

dimension
optional

string

dimensionName
optional

string

dimensionalQuantities
optional

< DimensionalQuantity > array

id
optional

integer (int64)

initialQuantity
optional

number (double)

issuedQuantity
optional

number (double)

lotIdentifier
optional

string

processOrderId
optional

integer (int64)

productCode
optional

Product Code of the BOM product

string

productId
optional

integer (int64)

requiredQuantity
optional

Required Quantity of the consumptions LOT

number

statusId
optional

integer (int64)

timeStamp
optional

string (date-time)

unitId
optional

integer (int64)

unitName
optional

string

unitOfMeasure
optional

Unit Of Measure of the BOM Item

string

unitOfMeasureId
optional

integer (int64)

userId
optional

integer (int64)

validStatusBasedOnRawMaterialInputConfig
optional

boolean

validUOMBasedOnBomItemConfig
optional

boolean

validUnitForConsumption
optional

boolean

3.14. BomResponse

Name Schema

isLastOperation
optional

boolean

mesServiceAvailable
optional

boolean

plannedLineId
optional

integer (int32)

routeBillOfMaterials
optional

< object > array

schemaVersion
optional

integer (int32)

segmentBillOfMaterials
optional

< object > array

3.15. ClockEntry

Name Description Schema

laborTypeId
optional

Suggested labor type id

integer (int64)

segmentActualId
optional

segmentActualId id of the workorder

integer (int64)

segmentId
optional

segmentId id of the workorder

integer (int64)

status
optional

status of the lot record

string

unitId
optional

unitId of the workorder

integer (int64)

3.16. ClockOnRecord

Name Schema

clockOffTime
optional

string (date-time)

clockOnTime
optional

string (date-time)

clockedOn
optional

boolean

id
optional

integer (int64)

laborTypeId
optional

integer (int64)

loggedInUser
optional

boolean

operator
optional

string

3.17. ClockRequest

Name Description Schema

clockEntries
optional

< ClockEntry > array

clockedOn
optional

Is clocked on of the record

boolean

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.18. CommonBomLotCreateAndConsumeRequest

Name Description Schema

bomItemId
optional

Bom Item ID, required for createAndConsume as well as just consume

integer (int64)

initialQuantity
optional

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
optional

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
optional

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
optional

quantityToConsume, required for createAndConsume as well as just consume

number (double)

returnLotStatusId
optional

Lot status for the return lot

integer (int32)

segmentId
optional

Segment ID, it is valid for work order only

integer (int64)

sourceLotUnitId
optional

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
optional

Source Material Lot ID, required for just consume. This the existing lot from which consumption will be done

integer (int64)

targetLotUnitId
optional

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
optional

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
optional

Unit of Measure ID of the bom item, required for createAndConsume as well as just consume

integer (int64)

workOrderId
optional

Work Order ID, it is valid for work order only

integer (int64)

3.19. CompleteOpStatus

Name Schema

enableComplete
optional

boolean

3.20. CompleteRequest

Name Description Schema

isSerialized
optional

Product is Serialized/Non-Serialized

boolean

lotIdentifier
optional

Lot Identifier

string

materialLotActualId
optional

materialLotActualId id of the workorder

integer (int64)

onHold
optional

Operation on Hold

boolean

operationName
optional

Operation Name

string

plannedQuantity
optional

Planned Quantity

integer (int32)

requiresClockOn
optional

Operation requires clockOn

boolean

segmentActualId
optional

segmentActualId id of the workorder

integer (int64)

segmentId
optional

SegmentId id of the workorder

integer (int64)

startedOnUnitId
optional

started On UnitId

integer (int64)

status
optional

Operation Status

string

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.21. CompleteRequestV2

Name Description Schema

isRecordCompleteTransaction
optional

Record Complete transaction of the operation

boolean

isSerialized
optional

Product is Serialized/Non-Serialized

boolean

nonClocking
optional

nonClocking of the Operation

boolean

operationName
optional

operationName of the workorder record

string

segmentActuals
optional

SegmentActuals id of the workorder

< SegmentActualCompleteRequestV2 > array

segmentId
optional

SegmentId of the workorder record

integer (int64)

workOrderId
optional

WorkorderId of the workorder record

integer (int64)

3.22. ConsumptionRecordInfo

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

entryOn
optional

Lot Entry On

string (date-time)

finalQuantity
optional

Final lot quantity

number (float)

id
optional

Consumption Record ID / event component ID

integer (int64)

initialQuantity
optional

Initial lot quantity

number (float)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier

string

lotStatus
optional

Lot status

string

productId
optional

Product ID / Applied Product ID

integer (int64)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

timeStamp
optional

Lot Timestamp

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

userId
optional

PA UserId

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.23. ConsumptionRecordRequest

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

returnLotStatusId
optional

Lot status for the return lot

integer (int32)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.24. DimensionalQuantity

Name Description Schema

currentQuantity
optional

Current Quantity of lot / Final Dimension

number (float)

dimension
optional

Dimension to which to which it belongs

string

dimensionName
optional

Dimension name of Subtype

string

initialQuantity
optional

Initial Quantity of lot for / Initial Dimension

number (double)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

3.25. Documents

Name Schema

routeDocumentReferences
optional

< object > array

segmentDocumentReferences
optional

< object > array

3.26. EntityCustomProperty

Name Schema

displayName
optional

string

entityId
optional

integer (int64)

entityType
optional

enum (PRODUCT, BOMFORMULATION, BOMFORMULATIONITEM)

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyDefinitionId
optional

string

propertyGroupId
optional

string

propertyGroupName
optional

string

propertyName
optional

string

propertyValue
optional

string

required
optional

boolean

uomCode
optional

string

uomId
optional

integer (int32)

3.27. Error

Name Schema

code
optional

string

details
optional

object

message
optional

string

3.28. ExternalConfigResponse

Name Schema

actionId
optional

integer (int64)

actionName
optional

string

actionType
optional

string

actionTypeId
optional

integer (int64)

configId
optional

integer (int64)

createdBy
optional

string

createdOn
optional

string

data
optional

object

deleted
optional

boolean

id
optional

integer (int64)

lastModifiedOn
optional

string

updatedBy
optional

string

3.29. ExternalConfigResponsePage

Name Schema

content
optional

< ExternalConfigResponse > array

links
optional

Links

page
optional

PageMetadata

3.30. FailedVariableInfo

Name Schema

lowerReject
optional

string

sample
optional

string

target
optional

string

testValue
optional

string

upperReject
optional

string

variableId
optional

integer (int64)

variableName
optional

string

3.31. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.32. InputParamterRequest

Name Schema

custom_property
optional

boolean

input_mapping_key
optional

string

input_parameter_data
optional

string

input_parameter_id
optional

integer (int64)

input_parameter_value
optional

string

property_definition_data_type_id
optional

integer (int32)

property_definition_data_type_name
optional

string

property_definition_id
optional

string

property_definition_initial_id
optional

string

property_definition_initial_value
optional

string

property_group_id
optional

string

3.33. ItemConsumptionRecord

Name Description Schema

bomItemId
optional

bomItemId

integer (int64)

consumedQuantity
optional

consumedQuantity

number (double)

consumedQuantityRaw
optional

consumedQuantityRaw

number (double)

finalLotQuantity
optional

Final lot quantity

number (float)

id
optional

Event components id

integer (int64)

initialLotQuantity
optional

Initial lot quantity

number (float)

lotIdentifier
optional

Source lotIdentifier

string

lotStatus
optional

Lot status

string

nonconformanceList
optional

nonconformanceList

< Nonconformance > array

operationName
optional

operationName

string

productCode
optional

Product Code of the BOM product

string

productId
optional

Product Id of the BOM product.

integer (int64)

quantityPrecision
optional

quantityPrecision

integer (int32)

sourceMaterialLotId
optional

sourceMaterialLotId

integer (int64)

targetMaterialLotId
optional

targetMaterialLotId

integer (int64)

timeStamp
optional

Time stamp for the consumption

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasure
optional

Unit Of Measure of the BOM Item

string

unitOfMeasureId
optional

unitOfMeasureId

integer (int64)

userId
optional

User Id of the user who made the consumption

integer (int64)

userName
optional

User Name of the user who made the consumption

string

3.34. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.35. Links

Name Schema

empty
optional

boolean

3.36. MaterialInfo

Name Schema

description
optional

string

productCode
optional

string

productFamilyId
optional

integer (int64)

productId
optional

integer (int64)

3.37. MaterialLotActualRecord

Name Description Schema

clockedOnRecords
optional

< ClockOnRecord > array

completedBy
optional

string

completedOn
optional

string (date-time)

completedOnUnitName
optional

operation started on unit name

string

completedQuantity
optional

integer (int32)

excludedBy
optional

string

excludedOnTime
optional

string (date-time)

holdOn
optional

string (date-time)

initialPlannedQuantity
optional

integer (int32)

materialLotActualId
optional

integer (int64)

materilLotActualName
optional

string

materilLotActualStatus
optional

string

oldPlannedQuantity
optional

integer (int32)

onHold
optional

boolean

onHoldBy
optional

string

plannedQuantity
optional

integer (int32)

productOverThreshold
optional

integer (int64)

productUnderThreshold
optional

integer (int64)

recordedQuantity
optional

integer (int32)

remainingQuantity
optional

integer (int32)

segmentActualId
optional

integer (int64)

segmentActualStatus
optional

string

skippedBy
optional

string

skippedOnTime
optional

string (date-time)

startedOn
optional

string (date-time)

startedOnUnitId
optional

integer (int64)

totalCompletedQuantity
optional

integer (int32)

unreadiedBy
optional

string

unreadiedOnTime
optional

string (date-time)

3.38. MaterialLotConsumptionRequest

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

initialQuantity
optional

Initial Quantity of LOT

number (double)

lotIdentifier
optional

New Material Lot Identifier

string

productId
optional

ProductId / Applied ProductId of new LOT

integer (int64)

quantity
optional

Consumed Quantity

number (double)

segmentId
optional

Segment ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

unitId
optional

Unit Id

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.39. MaterialLotEnableCompleteRequest

Name Description Schema

flagType
optional

flagType of the Request

integer (int32)

operationName
optional

operationName of the workorder record

string

processOrderId
optional

processOrderId of the workorder record

integer (int64)

productId
optional

productId of the workorder record

integer (int64)

segmentActuals
optional

segmentActuals of te Operation

< SegmentActual > array

segmentId
optional

segmentId of the workorder record

integer (int64)

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.40. MaterialLotInfoResult

Name Description Schema

availableForConsumption
optional

Is Available For Consumption

boolean

currentQuantity
optional

Current Quantity of lot / Final Dimension X

number (float)

dimension
optional

Dimension to which to which it belongs

string

dimensionName
optional

Dimension name of Subtype

string

dimensionalQuantities
optional

Collection of Dimensional quantities A,X,Y,Z

< DimensionalQuantity > array

extendedInfo
optional

Extended Information Receiver/OSP

string

id
optional

Material Lot ID / Event ID

integer (int64)

initialQuantity
optional

Initial Quantity of lot / Initial Dimension X

number (double)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier / Event Num

string

processOrderId
optional

ID of process order / pp_id

integer (int64)

productId
optional

Product ID / Applied Product ID

integer (int64)

statusId
optional

Lot status / Event Status

integer (int64)

timeStamp
optional

Time when the lot was created.

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

userId
optional

UserId of the user who created the lot.

integer (int64)

3.41. MaterialLotInfoResults

Name Schema

content
optional

< MaterialLotInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.42. MaterialLotRiskReleaseStatus

Name Schema

materialLotId
optional

integer (int64)

partialRiskRelease
optional

boolean

riskRelease
optional

boolean

3.43. MaterialLotStatus

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good

boolean

isInventoryStatus
optional

Is Inventory

boolean

isProductionStatus
optional

Is Production

boolean

3.44. MaterialLotStatusResult

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good

boolean

isInventoryStatus
optional

Is Inventory

boolean

isProductionStatus
optional

Is Production

boolean

links
optional

< Link > array

3.45. Nonconformance

Name Schema

defectId
optional

integer (int64)

defectStatus
optional

string

nonconformanceId
optional

integer (int64)

nonconformanceName
optional

string

3.46. OperationDetails

Name Description Schema

actualEndDate
optional

actualEndDate of the work order

string (date-time)

actualStartDate
optional

actualStartDate of the work order

string (date-time)

allowAdditionOfMaterialLotToInProgressWorkOrder
optional

Allow AdditionOf MaterialLot To InProgress WorkOrder of the work order operation

boolean

allowManualSkip
optional

Allow ManualSkip Optional Operation of a workOrder

boolean

allowManualStart
optional

allowManualStart behavior of Operation

boolean

appliesTo
optional

AppliesTo MaterialLotActuals on operation

< integer (int64) > array

behaviors
optional

Adding behaviors to operation

< string > array

children
optional

Segments Children

< integer (int64) > array

clockedOnRecords
optional

Clocked on users

< ClockOnRecord > array

completedBy
optional

Completed user

string

completedOn
optional

Completed Operation time

string (date-time)

completedOnUnitName
optional

operation started on unit name

string

createdBy
optional

Work order created user

string

defaultRecordQuantity
optional

defaultRecordQuantity flag of remaining quantity

boolean

displayOrder
optional

Segment Display Order

integer (int64)

holdOn
optional

OnHold Operation time

string (date-time)

isSerialized
optional

Product is Serialized/Non-Serialized

boolean

lotCompletedQuantity
optional

Lot Completed Quantity

integer (int32)

lotIdentifier
optional

LotIdentifier name of the workorder

string

lotInitialPlannedQuantity
optional

Lot Initial Planned Quantity

integer (int32)

lotPlannedQuantity
optional

Lot Planned Quantity

integer (int32)

lotRemainingQuantity
optional

Lot Remaining Quantity

integer (int32)

materialLotActualId
optional

LotIdentifier id of the workorder

integer (int64)

onHold
optional

On Hold state of the Operation

boolean

onHoldBy
optional

OnHold user

string

operationDesc
optional

Segment description of the work order

string

operationName
optional

Segment Identifier of the work order

string

plannedEndDate
optional

Work order planned end date

string (date-time)

plannedQuantity
optional

Work order planned quantity

integer (int32)

plannedStartDate
optional

Work order planned start date

string (date-time)

plannedUnitIds
optional

Operation planned on Units

< integer (int64) > array

processOrderId
optional

ProcessOrderId of work order

integer (int64)

productCode
optional

Product code of the workorder

string

productDesc
optional

Product Decription

string

productFamilyDesc
optional

Product family Description of the workorder

string

productFamilyId
optional

Product family id the workorder

integer (int64)

productId
optional

Product id of the workorder

integer (int64)

productOverThreshold
optional

Over Threshold value of a product

integer (int32)

productOverThresholdPercentage
optional

Over Threshold percentage of a product

number (double)

productUnderThreshold
optional

Under Threshold value of a product

integer (int32)

productUnderThresholdPercentage
optional

Under Threshold percentage of a product

number (double)

productionLineId
optional

Operation production line Id

integer (int64)

requiresClockOn
optional

NonClocking/Clocking Operation of a workOrder

boolean

routeDetails
optional

Route Object

RouteResponse

segmentActualId
optional

Segment actual id

integer (int64)

segmentId
optional

Segment id of the work order

integer (int64)

segmentStatus
optional

Segment status

string

segmentType
optional

Type of Segment

string

sequenceNumber
optional

Segment Sequence Number

integer (int32)

skipIfSuccessorStarted
optional

Operation of a workOrder can be skipped

boolean

startedOn
optional

startedOn Operation time

string (date-time)

startedOnUnitId
optional

Operation Started on Unit

integer (int64)

suggestedLaborTypes
optional

Suggested labor types for the operation

< integer (int32) > array

systemControlledOperationComplete
optional

systemControlledOperationComplete behavior of Operation

boolean

systemControlledOperationRecordQuantity
optional

systemControlledOperationRecordQuantity behavior of Operation

boolean

workOrderId
optional

Id of work order

integer (int64)

workOrderName
optional

Name of the work order

string

workOrderPriority
optional

Priority of the work order

integer (int32)

workOrderStartedOn
optional

Workorder started on time

string (date-time)

workOrderStatus
optional

status of the work order

string

workorderAvailable
optional

Still available(not completed) quantity

integer (int32)

workorderCompleted
optional

Completed quantity of the work order

integer (int32)

workorderQuantity
optional

Total quantity of the work order

integer (int32)

3.47. OperationPage

Name Schema

content
optional

< Operations > array

links
optional

Links

page
optional

PageMetadata

3.48. Operations

Name Description Schema

actualEndDate
optional

actualEndDate of the work order

string (date-time)

actualStartDate
optional

actualStartDate of the work order

string (date-time)

allowManualSkip
optional

Allow ManualSkip Optional Operation of a workOrder

boolean

allowManualStart
optional

allowManualStart behavior of Operation

boolean

clockedOnRecords
optional

Clocked on users

< ClockOnRecord > array

completedBy
optional

Completed user

string

completedOn
optional

Completed Operation time

string (date-time)

completedOnUnitName
optional

operation started on unit name

string

holdOn
optional

OnHold Operation time

string (date-time)

isSerialized
optional

Product is Serialized/Non-Serialized

boolean

links
optional

Links

lotCompletedQuantity
optional

Lot Completed Quantity

integer (int32)

lotIdentifier
optional

LotIdentifier name of the workorder

string

lotInitialPlannedQuantity
optional

Lot Initial Planned Quantity

integer (int32)

lotPlannedQuantity
optional

Lot Planned Quantity

integer (int32)

lotRemainingQuantity
optional

Lot Remaining Quantity

integer (int32)

materialLotActualId
optional

LotIdentifier id of the workorder

integer (int64)

onHold
optional

On Hold state of the Operation

boolean

onHoldBy
optional

OnHold user

string

operationDesc
optional

Segment description of the work order

string

operationName
optional

Segment Identifier of the work order

string

plannedEndDate
optional

plannedEndDate of the work order

string (date-time)

plannedQuantity
optional

Work order planned quantity

integer (int32)

plannedStartDate
optional

plannedStartDate of the work order

string (date-time)

plannedUnitIds
optional

Operation planned on Units

< integer (int64) > array

processOrderId
optional

ProcessOrderId of work order

integer (int64)

productCode
optional

Product code of the workorder

string

productDesc
optional

Product desc of the workorder

string

productFamilyDesc
optional

Product family Description of the workorder

string

productFamilyId
optional

Product family id the workorder

integer (int64)

productId
optional

Product id of the workorder

integer (int64)

productOverThreshold
optional

Over Threshold value of a product

integer (int32)

productOverThresholdPercentage
optional

Over Threshold percentage of a product

number (double)

productUnderThreshold
optional

Under Threshold value of a product

integer (int32)

productUnderThresholdPercentage
optional

Under Threshold percentage of a product

number (double)

productionLineId
optional

Operation production line Id

integer (int64)

requiresClockOn
optional

NonClocking/Clocking Operation of a workOrder

boolean

routeDetails
optional

Route Object

RouteResponse

segmentActualId
optional

Segment actual id

integer (int64)

segmentId
optional

Segment id of the work order

integer (int64)

segmentStatus
optional

Segment status

string

skipIfSuccessorStarted
optional

Operation of a workOrder can be skipped

boolean

startedOn
optional

startedOn Operation time

string (date-time)

startedOnUnitId
optional

Operation Started on Unit

integer (int64)

suggestedLaborTypes
optional

Suggested labor types for the operation

< integer (int32) > array

systemControlledOperationComplete
optional

systemControlledOperationComplete behavior of Operation

boolean

systemControlledOperationRecordQuantity
optional

systemControlledOperationRecordQuantity behavior of Operation

boolean

workOrderId
optional

Id of work order

integer (int64)

workOrderName
optional

Name of the work order

string

workOrderPriority
optional

Priority of the work order

integer (int32)

workOrderStartedOn
optional

Workorder started on time

string (date-time)

3.49. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.50. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.51. ProductCustomProperty

Name Schema

displayName
optional

string

productId
optional

integer (int64)

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyDefinitionId
optional

string

propertyGroupId
optional

string

propertyGroupName
optional

string

propertyName
optional

string

propertyValue
optional

string

required
optional

boolean

uomCode
optional

string

uomId
optional

integer (int32)

3.52. ProductFamily

Name Description Schema

description
optional

The product family’s description

string

id
optional

The unique Id of the product family

integer (int64)

links
optional

< Link > array

3.53. ProductFamilyPage

Name Schema

content
optional

< ProductFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.54. ProductionStatusTransitionResult

Name Description Schema

fromStatus
optional

From Production status value

string

fromStatusId
optional

From Production status id

integer (int32)

inventory
optional

Inventory status

boolean

toStatus
optional

List of To Production status values

< UnitStatusDetails > array

validStatusForInput
optional

From status is valid for input

boolean

3.55. PropertiesResponse

Name Schema

materialProperties
optional

< PropertyResponseMaterial > array

routeLevelProperties
optional

< string, < PropertyResponse > array > map

segmentProperties
optional

< string, < PropertyResponse > array > map

3.56. PropertyDefinitionInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defaultValue
optional

string

deleted
optional

boolean

displayName
optional

string

groupCreatedBy
optional

string

groupCreatedOn
optional

string (date-time)

id
optional

string

initialId
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyGroupId
optional

string

propertyGroupName
optional

string

protected
optional

boolean

required
optional

boolean

uom
optional

integer (int32)

version
optional

integer (int32)

3.57. PropertyDefinitionsPage

Name Schema

content
optional

< PropertyDefinitionInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.58. PropertyResponse

Name Schema

displayName
optional

string

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyDefinitionId
optional

string

propertyGroupId
optional

string

propertyGroupName
optional

string

propertyName
optional

string

propertyValue
optional

string

required
optional

boolean

segmentId
optional

integer (int64)

segmentName
optional

string

sequenceNumber
optional

integer (int64)

uomCode
optional

string

uomId
optional

integer (int32)

3.59. PropertyResponseMaterial

Name Schema

displayName
optional

string

productId
optional

integer (int64)

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyDefinitionId
optional

string

propertyGroupId
optional

string

propertyGroupName
optional

string

propertyName
optional

string

propertyValue
optional

string

required
optional

boolean

uomCode
optional

string

uomId
optional

integer (int32)

3.60. RecordQuantityEntryRequest

Name Description Schema

recordQuantity
optional

RecordQuantity of a operation serailLot

integer (int32)

segmentActualId
optional

SegmentActualId of a operation serialLot

integer (int64)

status
optional

Status of the lot record

string

3.61. RecordQuantityEntryResponse

Name Description Schema

remainingQuantity
optional

RemainingQuantity of a operation serailLot

integer (int32)

segmentActualId
optional

SegmentActualId of a operation serialLot

integer (int64)

3.62. RecordQuantityRequest

Name Description Schema

completeLotIdentifer
optional

complete LotIdentifer of the Operation

boolean

recordQuantityEntries
optional

RecordQuantityEntries of the workorder operation

< RecordQuantityEntryRequest > array

segmentId
optional

SegmentId id of the workorder

integer (int64)

startedOnUnitId
optional

startedOnUnitId of the Operation

integer (int64)

workOrderId
optional

SorkorderId of the workorder record

integer (int64)

3.63. RecordQuantityResponse

Name Description Schema

recordQuantityEntryResponses
optional

recordQuantityEntryResponses of the workorder operation

< RecordQuantityEntryResponse > array

segmentId
optional

SegmentId id of the workorder

integer (int64)

workOrderId
optional

workOrderId of the workorder record

integer (int64)

3.64. RiskReleaseDefectDTO

Name Schema

ncmTypeId
optional

integer (int64)

summary
optional

string

workOrder
optional

WorkOrderInfo

3.65. RouteResponse

Name Description Schema

lastModifiedOn
optional

Route lastModifiedOn

string (date-time)

minorRevision
optional

Route minor revision

integer (int32)

revision
optional

Route revision

integer (int32)

routeDefinitionId
optional

Route DefinitionId

integer (int64)

routeName
optional

Route name

string

3.66. SegmentActual

Name Description Schema

lotIdentifier
optional

lotIdentifier of materialLotActual

string

materialLotActualId
optional

materialLotActualId id of the SegmentActual

integer (int64)

plannedQuantity
optional

plannedQuantity of the Lot

integer (int32)

segmentActualId
optional

SegmentActualId id of the workorder

integer (int64)

startedOnUnitId
optional

startedOnUnitId of the Operation

integer (int64)

3.67. SegmentActualActivityVariableResponse

Name Schema

activityId
optional

integer (int64)

remainingMandatoryVariablesCount
optional

integer (int32)

3.68. SegmentActualActivtyRequest

Name Description Schema

clockedOn
optional

clocked on of the activity record

boolean

lotIdentifier
optional

lotIdentifier of materialLotActual

string

materialLotActualId
optional

materialLotActualId id of the SegmentActual

integer (int64)

segmentActualId
optional

SegmentActualId id of the workorder

integer (int64)

startedOnUnitId
optional

startedOnUnitId of the Operation

integer (int64)

3.69. SegmentActualActivtyResponse

Name Schema

activities
optional

< SegmentActualActivityVariableResponse > array

segmentActualId
optional

integer (int64)

3.70. SegmentActualBomCount

Name Schema

bomCount
optional

integer (int64)

segmentActualId
optional

integer (int64)

3.71. SegmentActualCompleteRequestV2

Name Description Schema

completedQuantity
optional

completedQuantity of the Operation lot

integer (int32)

lotIdentifier
optional

lotIdentifier of materialLotActual

string

lotInitialPlannedQuantity
optional

lotInitialPlannedQuantity of the Operation lot

integer (int32)

materialLotActualId
optional

materialLotActualId id of the workorder

integer (int64)

plannedQuantity
optional

plannedQuantity of the Operation lot

integer (int32)

segmentActualId
optional

segmentActualId id of the workorder

integer (int64)

segmentActualStatus
optional

segmentActualStatus of the lot record

string

startedOnUnitId
optional

startedOnUnitId of the Operation

integer (int64)

3.72. SkipRecordEntry

Name Description Schema

segmentActualId
optional

SegmentActualId id of the workorder

integer (int64)

startedOnUnitId
optional

started On UnitId

integer (int64)

status
optional

Status of the lot record

string

3.73. SkipRequest

Name Description Schema

segmentId
optional

segmentId of the workorder record

integer (int64)

skipEntries
optional

< SkipRecordEntry > array

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.74. SplitLotChildLotEntry

Split lot child lot information - used by the split lot command to identify details of a child lot to create.

Name Description Schema

completedQuantities
required

Completed quantities for in-progress operations on the child lot

< SplitLotCompletedQuantityEntry > array

lotIdentifier
required

Lot identifier for the child lot

string

plannedQuantity
required

Planned quantity for the child lot

integer (int32)

3.75. SplitLotCompletedQuantityEntry

Split lot completed quantity information - used by the split lot command to identify completed quantity on an in progress operations for a child lot

Name Description Schema

completedQuantity
required

Completed quantity for the in-progress operation

integer (int32)

segmentId
required

Segment ID for the in-progress operation

integer (int64)

3.76. SplitLotEntry

Split lot information - used by the split lot command to identify a material lot to split and details of the child lots to create.

Name Description Schema

childMaterialLots
required

Child material lot details

< SplitLotChildLotEntry > array

materialLotActualId
required

ID of the material lot actual to be split

integer (int64)

newLotIdentifier
optional

Optional new lot identifier name for the material lot being split. This allows using the existing lot identifier for one of the child lots. Set to null to keep existing lot identifier on the parent.

string

3.77. StartEntry

Name Description Schema

segmentActualId
optional

segmentActualId id of the workorder

integer (int64)

unitId
optional

unitId of the workorder

integer (int64)

3.78. StartRequest

Name Description Schema

startEntries
optional

< StartEntry > array

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.79. TabConfigData

Name Schema

authentication
optional

boolean

enable_seriallot
optional

boolean

external_url
optional

string

tab_input_parameters
optional

< InputParamterRequest > array

3.80. TabConfigExpressions

Type : object

3.81. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.82. TemplateVariables

Type : object

3.83. ToolUsageResponse

Name Schema

eventId
optional

integer (int64)

testId
optional

integer (int64)

toolId
optional

integer (int64)

toolUsedTimestamp
optional

string (date-time)

udeId
optional

integer (int64)

usageId
optional

integer (int64)

varId
optional

integer (int64)

3.84. UnitInfo

Name Schema

line
optional

string

lineId
optional

integer (int64)

unit
optional

string

unitId
optional

integer (int64)

validStatuses
optional

< MaterialLotStatusResult > array

3.85. UnitStatusDetails

Name Description Schema

statusId
optional

Status id

integer (int32)

statusName
optional

Status name

string

3.86. UnitsData

Name Description Schema

assetId
optional

The assetId of the unit

integer (int64)

lineId
optional

The lineId of the unit

integer (int64)

lineName
optional

The line name of the unit

string

name
optional

The name of the unit

string

3.87. UpdateToolUsageRequest

Name Schema

segmentActualId
optional

integer (int64)

testId
optional

integer (int64)

toolCategoryIds
optional

< integer (int64) > array

toolIds
optional

< integer (int64) > array

varId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.88. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.89. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

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

object

viewName
optional

string

3.90. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

3.91. VariableDetailsWithSpecs

Name Schema

activityId
optional

integer (int64)

actualValue
optional

string

dataTypeId
optional

integer (int32)

disable
optional

boolean

isUserDefinedDataType
optional

boolean

keyId1
optional

integer (int64)

lotIdentifier
optional

string

lowerRejectValue
optional

string

segmentActualId
optional

integer (int64)

targetValue
optional

string

upperRejectValue
optional

string

varId
optional

integer (int64)

variableName
optional

string

3.92. WorkOrder

Work order Data transfer object

Name Description Schema

cancelledOn
optional

Date that the work order was cancelled.

string (date-time)

completedBy
optional

The user that completed the work order.

string

completedOn
optional

Date that the work order was completed.

string (date-time)

createdBy
optional

User that created the work order.

string

createdOn
optional

Date that the work order was created.

string (date-time)

eTagValue
optional

Current ETag value of the work order resource

string

id
optional

Work Order ID.

integer (int64)

lastModifiedBy
optional

User that last modified the work order.

string

lastModifiedOn
optional

Date that the work order was last modified.

string (date-time)

name
optional

Work Order name.

string

plannedEndDate
optional

Planned end date for the work order.

string (date-time)

plannedQuantity
optional

The planned quantity to produce with this work order.

integer (int32)

plannedStartDate
optional

Planned start date for the work order.

string (date-time)

priority
optional

Relative priority of the work order.

integer (int32)

processOrderId
optional

Work order’s process order in the plant apps execution system.

integer (int64)

producedMaterialId
optional

Work order produced material ID.

integer (int64)

productionLineId
optional

Work order production line ID.

integer (int64)

readyOn
optional

Date that the work order was made ready.

string (date-time)

routeDefinitionId
optional

Refers to the route used to execute the work order.

integer (int64)

startedOn
optional

Date that the work order was started.

string (date-time)

status
optional

Status of the work order.

string

3.93. WorkOrderInfo

fields should be valid

Name Schema

affectedQuantity
optional

number (double)

bomItem
optional

< BomItem > array

failedVariable
optional

< FailedVariableInfo > array

lotIdentifier
optional

string

materialLotActualId
optional

integer (int64)

operationName
optional

string

producedMaterialId
optional

integer (int64)

segmentActualId
optional

integer (int64)

segmentId
optional

integer (int64)

serialized
optional

boolean

splitLotEntrys
optional

< SplitLotEntry > array

startedOnUnitId
optional

integer (int64)

workOrderId
optional

integer (int64)

workOrderName
optional

string

3.94. WorkQueue

Name Description Schema

actualEndDate
optional

actualEndDate of the work order

string (date-time)

actualStartDate
optional

actualStartDate of the work order

string (date-time)

allowAdditionOfMaterialLotToInProgressWorkOrder
optional

Allow AdditionOf MaterialLot To InProgress WorkOrder of the work order operation

boolean

allowManualSkip
optional

Allow ManualSkip Optional Operation of a workOrder

boolean

allowManualStart
optional

allowManualStart behavior of Operation

boolean

appliesTo
optional

appliesTo of the work order operation

AppliesTo

assignedToUser
optional

user assigned operations

boolean

completedOn
optional

completedOnDate of the work order

string (date-time)

defaultRecordQuantity
optional

defaultRecordQuantity of the work order operation

boolean

id
optional

integer (int64)

materialLotActualsRecords
optional

materialLotActuals on a workOrder

< MaterialLotActualRecord > array

operationDesc
optional

Segment description of the work order

string

operationName
optional

Segment Identifier of the work order

string

plannedEndDate
optional

plannedEndDate of the work order

string (date-time)

plannedQuantity
optional

Planned Quantity of the work order

integer (int32)

plannedStartDate
optional

plannedStartDate of the work order

string (date-time)

plannedUnitIds
optional

Operation planned on Unit Ids

< integer (int64) > array

plannedUnits
optional

Operation planned on Units

< UnitsData > array

processOrderId
optional

processOrderId of the work order

integer (int64)

productCode
optional

Product id of the workorder

string

productDesc
optional

Product desc of the workorder

string

productFamilyDesc
optional

ProductFamily desc of the workorder

string

productId
optional

Product id of the workorder

integer (int64)

productIsSerialized
optional

Product isSerialized of the workorder

boolean

productOverThresholdPercentage
optional

number (double)

productUnderThresholdPercentage
optional

number (double)

productionLineId
optional

productionLineId of the work order

integer (int64)

requiresClockOn
optional

requiresClockOn of the work order operation

boolean

routeDetails
optional

Route Object

RouteResponse

segmentId
optional

Segment id of the work order

integer (int64)

segmentStatus
optional

Segment status

string

skipIfSuccessorStarted
optional

Operation of a workOrder can be skipped

boolean

startedOn
optional

startedOnDate of the work order

string (date-time)

startedOnUnitId
optional

startedOnUnitId of the operation

integer (int64)

suggestedLaborTypes
optional

suggestedLaborTypes

< integer (int32) > array

systemControlledOperationComplete
optional

systemControlledOperationComplete behavior of Operation

boolean

systemControlledOperationRecordQuantity
optional

systemControlledOperationRecordQuantity behavior of Operation

boolean

workOrderId
optional

Id of work order

integer (int64)

workOrderName
optional

Name of the work order

string

workOrderPriority
optional

Priority of the work order

integer (int32)

workOrderStatus
optional

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.