1. Overview

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

1.1. URI scheme

Host : localhost
BasePath : /supervisor-app-service/

1.2. Tags

  • application-properties-controller : Application Properties Controller

  • bom-formulation-controller : Bom Formulation Controller

  • clock-on-controller : Clock On Controller

  • document-management-controller : Document Management Controller

  • history-controller : History Controller

  • labor-type-controller : Labor Type Controller

  • line-controller : Line Controller

  • material-controller : Material Controller

  • material-lot-controller : Material Lot Controller

  • operations-controller : Operations Controller

  • product-controller : Product Controller

  • product-family-controller : Product Family Controller

  • property-group-controller : Property Group Controller

  • summary-controller : Summary Controller

  • unit-controller : Unit Controller

  • user-settings-controller : User Settings Controller

  • work-order-segment-controller : Work Order Segment Controller

  • work-orders-controller : Work Orders Controller

2. Resources

2.1. Application-properties-controller

Application Properties Controller

2.1.1. Get Application Properties

GET /app/properties
Responses
HTTP Code Description Schema

200

OK

< string, string > map

401

Unauthorized

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Bom-formulation-controller

Bom Formulation Controller

2.2.1. Get BOM items by formulationId

GET /formulationItems
Parameters
Type Name Description Schema

Query

workOrderId
optional

Workorder Id for which BOM formulation details are required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

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.3. Clock-on-controller

Clock On Controller

2.3.1. clockOffUser

POST /workorders/{id}/clockOffUser
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

productionLineId
optional

ProductionLineId

integer (int64)

Body

clockOffByOperatorEntryInfos
optional

ClockOff User and Operation Details

< ClockOffByOperatorEntryInfo > array
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.3.2. getClockOnDetails

GET /workorders/{id}/clockOnDetails
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.4. Document-management-controller

Document Management Controller

2.4.1. API Endpoint to Create Metadata / Create revision for the documents

POST /documents
Parameters
Type Name Description Schema

Query

clientId
required

clientId, The data store (documents or media)

string

Body

documentMetaInfo
required

Metadata for creation of document or revision

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

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.2. API endpoint to Get Documents

GET /documents
Parameters
Type Name Description Schema

Query

clientId
required

clientId, The data store (documents or media)

string

Query

documentId
optional

document id

string

Query

workOrderId
optional

workOrderId, The workorder whose documents are required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.4.3. API endpoint to upload a document

PUT /documents
Parameters
Type Name Description Schema

Query

attachmentName
optional

Attachment Name

string

Query

clientId
required

ClientId, The data store (documents or media)

string

Query

docId
required

The document identifier

string

Query

rev
required

The Document Revision Id

string

FormData

file
required

The file that has to be uploaded

file
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • multipart/form-data

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.4. API endpoint to Get uploaded document

GET /documents/attachment
Parameters
Type Name Description Schema

Query

attachmentName
optional

attachment Name

string

Query

clientId
required

clientId, The data store (documents or media)

string

Query

documentId
required

document id or url

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.5. API endpoint to Create document reference

POST /documents/references
Parameters
Type Name Description Schema

Query

clientId
required

clientId The data store (documents or media)

string

Body

documentReference
required

Document reference

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

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.6. API endpoint to Get Revisions By InitialId

GET /documents/revision/{initialId}
Parameters
Type Name Description Schema

Path

initialId
optional

initial id

string

Query

clientId
optional

clientId The data store (documents or media)

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.5. History-controller

History Controller

2.5.1. getHistoryDetails

GET /workorders/{id}/historyDetails
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

materialLotActualId
optional

Material Lot Actual Id

integer (int64)

Query

segmentActualId
optional

SegmentActualId

integer (int64)

Query

segmentId
optional

Segment Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.6. Labor-type-controller

Labor Type Controller

2.6.1. Get all laborTypes

GET /laborTypes
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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. Line-controller

Line Controller

2.7.1. Get Route Enabled Lines

GET /lines
Responses
HTTP Code Description Schema

200

OK

< Line > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.8. Material-controller

Material Controller

2.8.1. Get Target Material Lot Details

GET /targetMaterialLot
Parameters
Type Name Description Schema

Query

lotIdentifier
optional

lotIdentifier

string

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.9. Material-lot-controller

Material Lot Controller

2.9.1. Get Material Lot Details

GET /workorders/{id}/materialLotDetails
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.9.2. Get Material Lot Details

GET /workorders/{id}/materialLots
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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. Operations-controller

Operations Controller

2.10.1. getOperations

GET /operations
Parameters
Type Name Description Schema

Query

completedAfter
optional

Fetch Operations created/completed after

string

Query

completedBefore
optional

Fetch Operations created/completed before

string

Query

completedTimeFrame
optional

Completed Timeframe of the Operation

enum (Last7Days)

Query

limitSearchResult
optional

limitSearchResult

boolean

Query

materialLotName
optional

Lot Identifier to Fetch the workorders from

string

Query

name
optional

WorkOrder Name to Fetch

string

Query

onHold
optional

Fetch only onHold Items

boolean

Query

page
optional

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

integer (int32)

Query

producedMaterialId
optional

Product Id to Fetch the workorders from

integer (int64)

Query

productFamilyId
optional

ProductFamily Ids to Fetch the workorders from

< integer (int64) > array(multi)

Query

productionLineId
optional

ProductionLine Ids to Fetch the workorders from

< integer (int64) > array(multi)

Query

size
optional

Number of records per page.

integer (int32)

Query

status
optional

Status of the WorkOrder (Ready, InProgress, Complete, Skipped)

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

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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. Product-controller

Product Controller

2.11.1. Get Products

GET /products
Responses
HTTP Code Description Schema

200

OK

< ProductInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.12. Product-family-controller

Product Family Controller

2.12.1. Get Product Families

GET /productFamilies
Responses
HTTP Code Description Schema

200

OK

< ProductFamilyInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.12.2. Get Products For Family

GET /productFamilies/getProducts/{productFamilyId}
Parameters
Type Name Description Schema

Path

productFamilyId
optional

ProductFamilyId to Fetch the products from

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ProductFamilyInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

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. Property-group-controller

Property Group Controller

2.13.1. Get all revisions for property-group-definition

GET /properties/definitions/{initialId}/revisions
Parameters
Type Name Description Schema

Path

initialId
optional

initialId for which property revisions are required

string
Responses
HTTP Code Description Schema

200

OK

object

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.2. Get all property groups list

GET /properties/groups
Parameters
Type Name Description Schema Default

Query

includeDeleted
optional

Include deleted items(true/false)

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.3. Get all property definitions by property group id

GET /properties/groups/{groupId}/definitions
Parameters
Type Name Description Schema

Path

groupId
optional

GroupId to fetch definitions from

string
Responses
HTTP Code Description Schema

200

OK

object

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.13.4. Get selected list of property groups for workorder or segment

GET /properties/workorders/{workOrderId}/segments/{segmentId}
Parameters
Type Name Description Schema

Path

segmentId
optional

Segment Id for which property details are required

integer (int64)

Path

workOrderId
optional

Workorder Id for which property details are required

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No selected group properties for the given request

object

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.14. Summary-controller

Summary Controller

2.14.1. getSummaryDetails

GET /workorders/{id}/summaryDetails
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id for which summary is required

integer (int64)

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.15. Unit-controller

Unit Controller

2.15.1. Get all units

GET /units
Parameters
Type Name Description Schema

Query

lineId
optional

Line Id for which unit details are required

integer (int32)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.16. User-settings-controller

User Settings Controller

2.16.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.16.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.16.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.16.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.16.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.17. Work-order-segment-controller

Work Order Segment Controller

2.17.1. Get WorkOrder Segments

GET /workorders/{id}/segments
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WorkOrderPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.17.2. Update WorkOrder Segments

PUT /workorders/{id}/segments
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

eTagValue
optional

eTagValue

string

Body

updatedSegmentsDefinitionObject
required

updatedSegmentsDefinitionObject

object
Responses
HTTP Code Description Schema

200

OK

WorkOrderPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.18. Work-orders-controller

Work Orders Controller

2.18.1. Get WorkOrders

GET /workorders
Parameters
Type Name Description Schema

Query

completedAfter
optional

Fetch Workorders created/completed after

string

Query

completedBefore
optional

Fetch Workorders created/completed before

string

Query

completedTimeFrame
optional

Completed Timeframe of the WorkOrder

enum (Last7Days)

Query

materialLotName
optional

Material Lot to be searched

< string > array(multi)

Query

name
optional

Name of the WorkOrder

string

Query

onHold
optional

Fetch only onHold Items

boolean

Query

orderBy
optional

Field by which response is sorted, default by Name (Name, Priority, PlannedStartDate)

string

Query

page
optional

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

integer (int32)

Query

priority
optional

Relative priority of the WorkOrder

integer (int32)

Query

producedMaterialId
optional

Product Id to Fetch the workorders from

integer (int64)

Query

productFamilyIds
optional

ProductFamily Ids to Fetch the workorders from

< integer (int64) > array(multi)

Query

productionLineId
optional

ProductionLine Ids to Fetch the workorders from

< integer (int64) > array(multi)

Query

size
optional

Number of records per page.

integer (int32)

Query

status
optional

Status of the WorkOrder (Ready, InProgress, Complete)

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

200

OK

WorkOrderPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.18.2. Get Workorder

GET /workorders/{id}
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

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.18.3. updateWorkOrderPriority

PUT /workorders/{id}
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

productionLineId
optional

ProductionLineId

integer (int64)

Body

workOrderDetails
optional

Relative priority of the WorkOrder

WorkOrderUpdateInfo
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.18.4. Cancel Workorder

POST /workorders/{id}/cancel
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

productionLineId
optional

ProductionLineId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.18.5. Get Lot Status Details

GET /workorders/{id}/currentLotStatus
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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.18.6. updateLotIdentifiers

POST /workorders/{id}/updateLotIdentifiers
Parameters
Type Name Description Schema

Path

id
optional

WorkOrder Id

integer (int64)

Query

productionLineId
optional

ProductionLineId

integer (int64)

Body

updateLotIdentifierEntriesinfo
optional

Workorder lot Identifiers

< UpdateLotIdentifierEntryinfo > array
Responses
HTTP Code Description Schema

200

OK

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

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

3. Definitions

3.1. BaseResponse

Name Schema

data
optional

object

depServiceStatusCode
optional

integer (int32)

message
optional

< string > array

statusCode
optional

integer (int32)

3.2. BillOfMaterialInfo

Bill of Materials of a route.

Name Description Schema

behaviors
required

Behaviours of a BOM item

object

bomItemId
required

Bom Item Id of the material

integer (int32)

defaultStorageUnitId
optional

V8: defaultStorageUnitId of a BOM item

integer (int32)

lowerTolerance
optional

V8: lowerTolerance of a BOM item

number (double)

lowerTolerancePrecision
optional

V8: lowerTolerancePrecision of a BOM item

integer (int32)

materialId
required

Id of the material

integer (int32)

propertyValues
optional

properties associated to a segment.

< PropertiesDefInfo > array

quantity
required

Quantity of the material

number (double)

quantityPrecision
required

V8: quantityPrecision of a BOM item

integer (int32)

scrapFactor
optional

V8: scrapFactor of a BOM item

object

unitOfMeasureId
required

Id of the unitOfMeasure

integer (int32)

upperTolerance
optional

V8: upperTolerance of a BOM item

number (double)

upperTolerancePrecision
optional

V8: upperTolerancePrecision of a BOM item

integer (int32)

visualization
required

Visualization of a BOM item

BillOfMaterialsVisualization

3.3. BillOfMaterialsVisualization

Behaviours for Bill of Material of a route.

Name Description Schema

displayOrder
required

BOM item requires displayOrder

integer (int32)

3.4. ClockOffByOperatorEntryInfo

Clock Off User By Operator Data Transfer Object

Name Description Schema

operatorName
optional

Name of the User to be clocked off

string

segmentActualId
optional

Id of the segment actual that is to be clocked off

integer (int64)

3.5. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.6. DocumentInfo

Documents of a route.

Name Description Schema

displayName
required

Name of the document

string

link
required

Link of the document

string

3.7. Error

Name Schema

code
optional

string

details
optional

object

3.8. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.9. Line

Name Description Schema

assetId
optional

The asset ID

integer (int64)

isRouteEnabled
optional

Is this line route enabled. A route enabled line is ready to be used by the route service and has been properly configured.
Example : false

boolean

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

units
optional

Collection of Units belonging to this Line

UnitCollection

3.10. Link

Holds a resource link to support HATEOAS

Name Description Schema

href
optional

URL for the link.

string

rel
optional

Type or relation of the link.

string

templated
optional

Indicates if the link uses templating.
Example : false

boolean

3.11. MaterialLotDetailsInfo

Name Description Schema

id
optional

Unique Identifier for the Material Lot

integer (int64)

name
optional

Name of the Lot

string

status
optional

Status of the Lot

string

workOrderId
optional

Unique Identifier for the WorkOrder

integer (int64)

3.12. OperationsInfo

Operations of a route.

Name Description Schema

id
required

Id of the operation

integer (int64)

sequenceNumber
required

Sequence number of the operation

integer (int32)

skipIfSuccessorStarted
optional

V8: Indicates if implicit skip is enabled
Example : false

boolean

3.13. PageMetadata

Page size and location information.

Name Description Schema

number
optional

Current page number.

integer (int32)

size
optional

Maximum number of resources on a page.

integer (int32)

totalElements
optional

Total number of resources in the paged collection.

integer (int32)

totalPages
optional

Total number of pages in the paged collection.

integer (int32)

3.14. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.15. ProductFamilyInfo

Product Family data transfer object

Name Description Schema

id
optional

Unique Identifier for the Product Family

integer (int64)

name
optional

Name of the Product Family

string

3.16. ProductInfo

Product data transfer object

Name Description Schema

familyId
optional

Family to which the product belongs

integer (int64)

id
optional

Unique Identifier for the Product

integer (int64)

name
optional

Name of the Product

string

3.17. PropertiesDefInfo

Properties of a route.

Name Description Schema

propertyDefinitionId
required

Id of property

string

propertyValue
required

Value of property

string

3.18. RouteSegmentInfo

RouteSegment data tranfer object

Name Description Schema

id
required

id of the route Segment

integer (int64)

3.19. SegmentsAppliesTo

Qualifiers for the segment definition.

Name Description Schema

materialLotActualIds
required

Material lot actual(s) that the segment applies to. Applies to all material lot actual(s) if empty.

< integer (int64) > array

3.20. StructureInfo

Name Description Schema

operations
required

List of operations

< OperationsInfo > array

routeSegment
required

Route segment details

RouteSegmentInfo

3.21. TargetMaterialLotDetailsInfo

Name Description Schema

id
optional

Unique Identifier for the Target Material Lot

integer (int64)

lotIdentifier
optional

Name of the lot identifier

string

productId
optional

Applied product id for the Target Material Lot

integer (int64)

3.22. Unit

Name Description Schema

assetId
optional

The asset ID

integer (int64)

isInventoryUnit
optional

Is this unit an inventory unit. A inventory unit is a storage unit.
Example : false

boolean

isVirtual
optional

Is this unit a virtual unit. A virtual unit is a tracking unit. It doesn’t have physical assets associated with it.
Example : false

boolean

lineId
optional

The line this unit belongs to

integer (int64)

links
optional

< Link > array

name
optional

The name of the asset

string

type
optional

The type of the asset

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

unitRank
optional

This unit’s rank

integer (int32)

units
optional

Collection of Groups belonging to this Unit

UnitCollection

3.23. UnitCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Unit > array

links
optional

< Link > array

3.24. UpdateLotIdentifierEntryinfo

Material lot identifier update object

Name Description Schema

lotIdentifier
optional

lotIdentifier for the WorkOrder

string

materialLotActualId
optional

MaterialLot Actual Id of the WorkOrder

integer (int64)

3.25. 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.26. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.27. WorkOrder

Work order Data transfer object

Name Description Schema

cancelledOn
optional

Date that the work order was cancelled.

string (date-time)

completedOn
optional

Date that the work order was completed.

string (date-time)

createdBy
optional

User that created the route.

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 route.

string

lastModifiedOn
optional

Date that the route was last modified.

string (date-time)

links
optional

Set of links on the resource.

< Link > array

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.28. WorkOrderPage

Contains a page of resources and the links required to navigate over pages.

Name Description Schema

content
optional

Set of resources on the page.

< WorkOrder > array

links
optional

Set of links on the resource.

< Link > array

page
optional

PageMetadata

3.29. WorkOrderSegmentDefinitionInfo

Name Schema

eTagValue
optional

string

lotStatus
optional

< MaterialLotDetailsInfo > array

plannedLineId
optional

integer (int64)

producedMaterialId
optional

integer (int64)

schemaVersion
optional

integer (int32)

segments
optional

< WorkOrderSegmentInfo > array

structure
optional

StructureInfo

structureType
optional

string

3.30. WorkOrderSegmentInfo

Segments data transfer object

Name Description Schema

appliesTo
required

Qualifiers for operations based on this segment.

SegmentsAppliesTo

behaviors
optional

Behaviors of a segment

< string > array

billOfMaterials
optional

Bill of materials associated to a segment.

< BillOfMaterialInfo > array

description
optional

Description of the segment.

string

documents
optional

documents associated to a segment.

< DocumentInfo > array

id
required

id of the route segment

integer (int64)

name
required

Name of the segment.

string

plannedUnitIds
optional

units associated to a segment.

< integer (int64) > array

propertyValues
optional

properties associated to a segment.

< PropertiesDefInfo > array

segmentOnHold
optional

boolean

segmentType
required

Type of the segment. Possible options are Segment, Reference

string

sequenceNumber
optional

Sequence Number of the Segment

integer (int32)

status
optional

Status of the segment derived from segment actuals

string

suggestedLaborTypes
required

Labor types to expected on operations for this segment. First value is the default labor type.

< integer (int64) > array

3.31. WorkOrderUpdateInfo

WorkOrder data update object

Name Description Schema

eTagValue
optional

If Match Header for WorkOrder

string

plannedEndDate
optional

Planned end date for the WorkOrder

string (date-time)

plannedStartDate
optional

Planned start date for the WorkOrder

string (date-time)

priority
optional

Relative priority of the WorkOrder

integer (int32)

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : http://localhost:8443/uaa/oauth/authorize
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://localhost:8443/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.