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

  • consumption-operations-controller : Consumption Operations Controller

  • document-management-controller : Document Management Controller

  • engineering-unit-controller : Engineering Unit Controller

  • external-config-controller : External Config Controller

  • labor-type-controller : Labor Type Controller

  • material-controller : Material Controller

  • operator-controller : Operator Controller

  • permission-check-controller : Permission Check Controller

  • properties-controller : Properties Controller

  • user-settings-controller : User Settings Controller

  • work-queue-controller : Work Queue Controller

2. Resources

2.1. Activity-controller

Activity Controller

2.1.1. List of activities containing and activity variable counts

POST /activities/activityVariableCounts
Parameters
Type Name Description Schema

Body

activityVariablesRequest
required

activityVariablesRequest

ActivityVariablesRequest
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
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Fetches List of activities containing their variable counts

GET /activities/activityVariableCounts
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. activties

GET /activities/ids
Parameters
Type Name Description Schema

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. To check form is Custom form

GET /activities/isCustomform
Parameters
Type Name Description Schema

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Application-tab-controller

Application Tab Controller

2.2.1. Get tabs mapped to appId.

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

Path

appId
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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.2. Get tab details mapped to appId

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

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Bom-reallocation-genealogy-controller

Bom Reallocation Genealogy Controller

2.3.1. Get reallocation genealogy info

GET /reallocation/genealogy
Parameters
Type Name Description Schema

Query

bomItemId
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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Consumption-operations-controller

Consumption Operations Controller

2.4.1. Create a consumption record

POST /consumptionOperations
Parameters
Type Name Description Schema

Query

resourceId
optional

Resource id to validate the permission forconsumption.

integer (int64)

Query

resourceType
optional

Resource 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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.2. Get Consumption lots

GET /consumptionOperations
Parameters
Type Name Description Schema Default

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.3. Create lot and consume that Lot

POST /consumptionOperations/materialLot
Parameters
Type Name Description Schema

Query

resourceId
optional

Resource id to validate the permission forconsumption.

integer (int64)

Query

resourceType
optional

Resource 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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Document-management-controller

Document Management Controller

2.5.1. Get document

GET /documents/attachment
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Engineering-unit-controller

Engineering Unit Controller

2.6.1. Get All Units By ProductId

GET /engineeringunits
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7. External-config-controller

External Config Controller

2.7.1. Get Configurations

GET /v1/configurations
Parameters
Type Name Description Schema Default

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8. Labor-type-controller

Labor Type Controller

2.8.1. getLaborTypes

GET /laborTypes
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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9. Material-controller

Material Controller

2.9.1. Get all the materials

GET /materials
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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9.2. Get list of materialLots and their properties

GET /materials/materialLots
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9.3. Get product families

GET /materials/productFamilies
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9.4. Get MaterialLot Status by Id from product service

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

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10. Operator-controller

Operator Controller

2.10.1. Query Operations

GET /operations
Parameters
Type Name Description Schema Default

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

"false"

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

GET /operations/boms
Parameters
Type Name Description Schema

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.3. Clock on/off an operation

POST /operations/clock
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.4. Complete of an operation

POST /operations/complete
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.5. Operation details

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

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.6. fetchTargetMaterialLot

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

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

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

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.8. Documents of an operation

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

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.9. Skip an operation

POST /operations/skip
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.10. Units of all lines

GET /operations/units
Responses
HTTP Code Description Schema

200

OK

< UnitsData > array

401

Unauthorized

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.10.11. Operation

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

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.11. Permission-check-controller

Permission Check Controller

2.11.1. checkPermission

GET /checkPermission
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.12. Properties-controller

Properties Controller

2.12.1. Get Property Details

GET /properties
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13. User-settings-controller

User Settings Controller

2.13.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.5. Get Privilege Sets

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

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14. Work-queue-controller

Work Queue Controller

2.14.1. Get collection of operations by workorders.

GET /workqueue
Parameters
Type Name Description Schema Default

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
required

workOrderId

< integer (int64) > array(multi)
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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

POST /workqueue/checkEnableComplete
Parameters
Type Name Description Schema

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14.3. Complete multiple segmentActuals in a workorder.

POST /workqueue/complete
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14.4. Get a page of the operations collection.

GET /workqueue/operations
Parameters
Type Name Description Schema Default

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)

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14.5. Get clocked on and assigned operations collection.

GET /workqueue/queue
Parameters
Type Name Description Schema Default

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14.6. RecordQuantity a serialLot operation

POST /workqueue/recordQuantity
Parameters
Type Name Description Schema

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

GET /workqueue/search
Parameters
Type Name Description Schema Default

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

POST /workqueue/unConsumedBomCount
Parameters
Type Name Description Schema

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;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. 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. 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.5. ApplicationTabResponseResource

Name Schema

description
optional

string

displayName
optional

string

enabled
optional

boolean

id
optional

integer (int64)

links
optional

< Link > array

sequenceOrder
optional

integer (int32)

standard
optional

boolean

3.6. ApplicationTabResponseResults

Name Schema

content
optional

< ApplicationTabResponseResource > array

links
optional

< Link > array

page
optional

PageMetadata

3.7. AppliesTo

Name Schema

materialLotActualIds
optional

< integer (int64) > array

3.8. BomCountRequest

Name Description Schema

isHeaderCount
optional

isHeaderCount check the Bom count is for header
Example : false

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.9. BomCountResponse

Name Schema

bomTotalCount
optional

integer (int64)

segmentActualBomCount
optional

< SegmentActualBomCount > array

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.10. 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.11. 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.12. 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.13. ClockRequest

Name Description Schema

clockEntries
optional

< ClockEntry > array

clockedOn
optional

Is clocked on of the record
Example : false

boolean

workOrderId
optional

workorderId of the workorder record

integer (int64)

3.14. CompleteOpStatus

Name Schema

enableComplete
optional

boolean

3.15. CompleteRequest

Name Description Schema

isSerialized
optional

Product is Serialized/Non-Serialized
Example : false

boolean

materialLotActualId
optional

materialLotActualId id of the workorder

integer (int64)

onHold
optional

Operation on Hold
Example : false

boolean

requiresClockOn
optional

Operation requires clockOn
Example : false

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.16. CompleteRequestV2

Name Description Schema

nonClocking
optional

nonClocking of the Operation
Example : false

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.17. 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)

id
optional

Consumption Record ID / event component ID

integer (int64)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier

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.18. ConsumptionRecordRequest

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

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.19. Documents

Name Schema

routeDocumentReferences
optional

< object > array

segmentDocumentReferences
optional

< object > array

3.20. Error

Name Schema

code
optional

string

details
optional

object

message
optional

string

3.21. ExternalConfigResponse

Name Description 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

Example : false

boolean

id
optional

integer (int64)

lastModifiedOn
optional

string

updatedBy
optional

string

3.22. ExternalConfigResponsePage

Name Schema

content
optional

< ExternalConfigResponse > array

links
optional

< Link > array

page
optional

PageMetadata

3.23. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.24. 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_id
optional

string

property_definition_initial_id
optional

string

property_definition_initial_value
optional

string

property_group_id
optional

string

3.25. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.26. MaterialInfo

Name Schema

description
optional

string

productCode
optional

string

productFamilyId
optional

integer (int64)

productId
optional

integer (int64)

3.27. MaterialLotActualRecord

Name Schema

clockedOnRecords
optional

< ClockOnRecord > array

completedBy
optional

string

completedOn
optional

string (date-time)

completedQuantity
optional

integer (int32)

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.28. 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.29. 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.30. MaterialLotInfoResult

Name Description Schema

availableForConsumption
optional

Is Available For Consumption
Example : false

boolean

currentQuantity
optional

Current Quantity of lot / Final Dimension X

number (float)

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)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

3.31. MaterialLotInfoResults

Name Schema

content
optional

< MaterialLotInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.32. MaterialLotStatus

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good
Example : false

boolean

isInventoryStatus
optional

Is Inventory
Example : false

boolean

isProductionStatus
optional

Is Production
Example : false

boolean

3.33. OperationDetails

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
Example : false

boolean

clockedOnRecords
optional

Clocked on users

< ClockOnRecord > array

completedBy
optional

Completed user

string

completedOn
optional

Completed Operation time

string (date-time)

createdBy
optional

Work order created user

string

defaultRecordQuantity
optional

defaultRecordQuantity flag of remaining quantity
Example : false

boolean

holdOn
optional

OnHold Operation time

string (date-time)

id
optional

integer (int64)

isSerialized
optional

Product is Serialized/Non-Serialized
Example : false

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
Example : false

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)

plannedStartDate
optional

Work order planned start date

string (date-time)

plannedUnitIds
optional

Operation planned on Units

< integer (int64) > array

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)

requiresClockOn
optional

NonClocking/Clocking Operation of a workOrder
Example : false

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
Example : false

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

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)

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.34. OperationPage

Name Schema

content
optional

< Operations > array

links
optional

< Link > array

page
optional

PageMetadata

3.35. 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
Example : false

boolean

clockedOnRecords
optional

Clocked on users

< ClockOnRecord > array

completedBy
optional

Completed user

string

completedOn
optional

Completed Operation time

string (date-time)

holdOn
optional

OnHold Operation time

string (date-time)

id
optional

integer (int64)

isSerialized
optional

Product is Serialized/Non-Serialized
Example : false

boolean

links
optional

< Link > array

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
Example : false

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)

plannedStartDate
optional

plannedStartDate of the work order

string (date-time)

plannedUnitIds
optional

Operation planned on Units

< integer (int64) > array

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)

requiresClockOn
optional

NonClocking/Clocking Operation of a workOrder
Example : false

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
Example : false

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

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)

3.36. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.37. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.38. 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.39. ProductFamilyPage

Name Schema

content
optional

< ProductFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.40. PropertiesResponse

Name Schema

materialProperties
optional

< PropertyResponseMaterial > array

routeLevelProperties
optional

< string, < PropertyResponse > array > map

segmentProperties
optional

< string, < PropertyResponse > array > map

3.41. 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)

uomCode
optional

string

uomId
optional

integer (int32)

3.42. 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.43. 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.44. RecordQuantityEntryResponse

Name Description Schema

remainingQuantity
optional

RemainingQuantity of a operation serailLot

integer (int32)

segmentActualId
optional

SegmentActualId of a operation serialLot

integer (int64)

3.45. RecordQuantityRequest

Name Description Schema

completeLotIdentifer
optional

complete LotIdentifer of the Operation
Example : false

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.46. 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.47. RouteResponse

Name Description Schema

lastModifiedOn
optional

Route lastModifiedOn

string (date-time)

revision
optional

Route revision

integer (int32)

routeDefinitionId
optional

Route DefinitionId

integer (int64)

routeName
optional

Route name

string

3.48. 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.49. SegmentActualActivityVariableResponse

Name Schema

activityId
optional

integer (int64)

remainingMandatoryVariablesCount
optional

integer (int32)

totalMandatoryVariablesCount
optional

integer (int32)

totalVariablesCount
optional

integer (int32)

3.50. SegmentActualActivtyRequest

Name Description Schema

clockedOn
optional

clocked on of the activity record
Example : false

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.51. SegmentActualActivtyResponse

Name Schema

activities
optional

< SegmentActualActivityVariableResponse > array

segmentActualId
optional

integer (int64)

3.52. SegmentActualBomCount

Name Schema

bomCount
optional

integer (int64)

segmentActualId
optional

integer (int64)

3.53. SegmentActualCompleteRequestV2

Name Description Schema

lotIdentifier
optional

lotIdentifier of materialLotActual

string

materialLotActualId
optional

materialLotActualId id of the workorder

integer (int64)

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.54. 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.55. 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.56. TabConfigData

Name Schema

authentication
optional

boolean

enable_seriallot
optional

boolean

external_url
optional

string

tab_input_parameters
optional

< InputParamterRequest > array

3.57. TabConfigExpressions

Type : object

3.58. 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.59. 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.60. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.61. WorkQueue

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
Example : false

boolean

appliesTo
optional

appliesTo of the work order operation

AppliesTo

assignedToUser
optional

user assigned operations
Example : false

boolean

completedOn
optional

completedOnDate of the work order

string (date-time)

defaultRecordQuantity
optional

defaultRecordQuantity of the work order operation
Example : false

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
Example : false

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
Example : false

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
Example : false

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

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)

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.