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

  • application-tab-controller : Application Tab Controller

  • bom-formulation-controller : Bom Formulation Controller

  • clock-on-controller : Clock On Controller

  • document-management-controller : Document Management Controller

  • external-config-controller : External Config 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

  • product-property-value-controller : Product Property Value Controller

  • property-group-controller : Property Group Controller

  • summary-controller : Summary Controller

  • unit-controller : Unit Controller

  • user-settings-controller : User Settings Controller

  • work-order-component-controller : Work Order Component 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
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< string, string > map

401

Unauthorized

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Application-tab-controller

Application Tab Controller

2.2.1. Get tabs mapped to appId.

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

appId
required

appId

integer (int64)

Query

enabled
optional

enabled

boolean

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

< ApplicationTabResponseResults > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Get tab details mapped to appId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

appId
required

appId

integer (int64)

Path

tabId
required

tabId

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ApplicationTabDetailResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Bom-formulation-controller

Bom Formulation Controller

2.3.1. Get BOM items by formulationId

GET /formulationItems
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. Get PropertyDefinitions Metadata from property definitionIds

GET /formulationItems/propertyDefinitionDetails
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

propertyDefinitionIds
required

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

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

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Clock-on-controller

Clock On Controller

2.4.1. clockOffUser

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.2. getClockOnDetails

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5. Document-management-controller

Document Management Controller

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

POST /documents
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.2. API endpoint to Get Documents

GET /documents
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

clientId
required

clientId, The data store (documents or media)

string

Query

documentId
optional

document id

string

Query

offset
optional

integer (int64)

Query

pageNumber
optional

integer (int32)

Query

pageSize
optional

integer (int32)

Query

paged
optional

boolean

Query

sort.sorted
optional

boolean

Query

sort.unsorted
optional

boolean

Query

unpaged
optional

boolean

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.3. API endpoint to upload a document

PUT /documents
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.4. API endpoint to Get uploaded document

GET /documents/attachment
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

attachmentName
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.5. API endpoint to Create document reference

POST /documents/references
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5.6. API endpoint to Get Revisions By InitialId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. External-config-controller

External Config Controller

2.6.1. Get Configurations

GET /v1/configurations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

actionId
optional

actionId

integer (int32)

Query

actionName
optional

actionName

string

Query

actionTypeId
optional

actionTypeId

integer (int32)

Query

configId
optional

configId

integer (int64)

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

segmentId
optional

segmentId

integer (int64)

Query

size
optional

size

integer (int32)

20

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ExternalConfigResponsePage

204

No Content, Error retrieving actions

HttpErrorResponse

401

User Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7. History-controller

History Controller

2.7.1. getHistoryDetails

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8. Labor-type-controller

Labor Type Controller

2.8.1. Get all laborTypes

GET /laborTypes
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9. Line-controller

Line Controller

2.9.1. Get Route Enabled Lines

GET /lines
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10. Material-controller

Material Controller

2.10.1. Get Target Material Lot Details

GET /targetMaterialLot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11. Material-lot-controller

Material Lot Controller

2.11.1. Get Material Lot Details

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11.2. Get Material Lot Details

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12. Operations-controller

Operations Controller

2.12.1. getOperations

GET /operations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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) > array(multi)

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13. Product-controller

Product Controller

2.13.1. Get Products

GET /products
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

productId
optional

productId

integer (int64)
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14. Product-family-controller

Product Family Controller

2.14.1. Get Product Families

GET /productFamilies
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.2. Get Products For Family

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15. Product-property-value-controller

Product Property Value Controller

2.15.1. Get property values for product

GET /v1/product/{productId}/properties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

product 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

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16. Property-group-controller

Property Group Controller

2.16.1. Get all revisions for property-group-definition

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16.2. Get all property groups list

GET /properties/groups
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16.3. Get all property definitions by property group id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

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

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

workOrderId
optional

Workorder Id for which property details are required

integer (int64)

Query

segmentId
optional

Segment 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17. Summary-controller

Summary Controller

2.17.1. getSummaryDetails

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18. Unit-controller

Unit Controller

2.18.1. Get all units

GET /units
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.2. Get all departments

GET /units/departments
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

object

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19. User-settings-controller

User Settings Controller

2.19.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

userSettingsRequest
required

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResponseResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

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

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

string

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.5. Get Privilege Sets

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20. Work-order-component-controller

Work Order Component Controller

2.20.1. Add alot

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

workOrderId
required

workOrderId

integer (int64)

Query

authenticated
optional

boolean

Query

authorities[0].authority
optional

string

Query

credentials
optional

object

Query

details
optional

object

Query

principal
optional

object

Query

status
required

status

string

Body

addLotEntry
required

addLotEntry

< AddLotEntry > array
Responses
HTTP Code Description Schema

200

OK

object

201

Created

WorkOrder

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21. Work-order-segment-controller

Work Order Segment Controller

2.21.1. Get WorkOrder Segments

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.2. Update WorkOrder Segments

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22. Work-orders-controller

Work Orders Controller

2.22.1. Get WorkOrders

GET /workorders
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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) > array(multi)

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.2. Get Workorder

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.3. updateWorkOrderPriority

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.4. Cancel Workorder

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.5. Get Lot Status Details

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.6. updateLotIdentifiers

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.7. Cancel Material Lot

POST /workorders/{workOrderId}/cancellot
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

workOrderId
optional

WorkOrderID

integer (int64)

Body

materialLotIds
required

materialLotIds

< integer (int64) > 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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.22.8. completeworkorder

POST /workorders/{workOrderId}/completeworkorder
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

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

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. AddLotEntry

Material lot information used by the add lot command to identify the material lot identifiers and their planned quantity.

Name Description Schema

lotIdentifier
required

Identifier for this material lot

string

plannedQuantity
required

The planned quantity to produce with this material lot.

integer (int32)

3.2. 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.3. ApplicationTabResponseResource

Name Schema

description
optional

string

displayName
optional

string

enabled
optional

boolean

id
optional

integer (int64)

links
optional

Links

sequenceOrder
optional

integer (int32)

standard
optional

boolean

3.4. ApplicationTabResponseResults

Name Schema

content
optional

< ApplicationTabResponseResource > array

links
optional

Links

page
optional

PageMetadata

3.5. AppliesTo

Name Schema

excludedMaterialLotActualIds
optional

< integer (int64) > array

materialLotActualIds
optional

< integer (int64) > array

3.6. AssociatedProduct

Name Schema

associationId
optional

integer (int64)

productId
optional

integer (int64)

unitId
optional

integer (int64)

3.7. BaseResponse

Name Schema

data
optional

object

depServiceStatusCode
optional

integer (int32)

message
optional

< string > array

statusCode
optional

integer (int32)

3.8. BomFormulation

Name Schema

associatedProducts
optional

< AssociatedProduct > array

behaviors
optional

< string > array

crossReferences
optional

< CrossReference > array

effectiveDate
optional

string

expirationDate
optional

string

formulationCode
optional

string

formulationDescription
optional

string

formulationItems
optional

< FormulationItem > array

producedQuantity
optional

number (double)

producedQuantityPrecision
optional

integer (int32)

producedQuantityUnitOfMeasureId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

schemaVersion
optional

integer (int64)

3.9. 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.10. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.11. CrossReference

Name Schema

externalId
optional

string

externalSystemId
optional

integer (int64)

3.12. Document

Name Schema

displayName
optional

string

link
optional

string

3.13. Error

Name Schema

code
optional

string

details
optional

object

3.14. ExternalConfigResponse

Name Schema

actionId
optional

integer (int64)

actionName
optional

string

actionType
optional

string

actionTypeId
optional

integer (int64)

configId
optional

integer (int64)

createdBy
optional

string

createdOn
optional

string

data
optional

object

deleted
optional

boolean

id
optional

integer (int64)

lastModifiedOn
optional

string

updatedBy
optional

string

3.15. ExternalConfigResponsePage

Name Schema

content
optional

< ExternalConfigResponse > array

links
optional

Links

page
optional

PageMetadata

3.16. FormulationItem

Name Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

displayOrder
optional

integer (int32)

itemId
optional

integer (int64)

itemReference
optional

string

locationId
optional

integer (int64)

lotDescription
optional

string

lowerTolerance
optional

number (double)

lowerTolerancePrecision
optional

integer (int64)

productCode
optional

string

productDescription
optional

string

productId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

scrapFactor
optional

number (double)

substitutions
optional

< Substitution > array

unitId
optional

integer (int64)

unitName
optional

string

unitOfMeasureId
optional

integer (int64)

uomCode
optional

string

uomDescription
optional

string

upperTolerance
optional

number (double)

upperTolerancePrecision
optional

integer (int64)

3.17. FormulationItemsConsumption

Name Schema

behaviors
optional

< string > array

itemReference
optional

string

lowerTolerance
optional

number (double)

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

upperTolerance
optional

number (double)

3.18. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.19. InputParamterRequest

Name Schema

custom_property
optional

boolean

input_mapping_key
optional

string

input_parameter_data
optional

string

input_parameter_id
optional

integer (int64)

input_parameter_value
optional

string

property_definition_data_type_id
optional

integer (int32)

property_definition_data_type_name
optional

string

property_definition_id
optional

string

property_definition_initial_id
optional

string

property_definition_initial_value
optional

string

property_group_id
optional

string

3.20. LaborPlan

Name Schema

laborCodes
optional

< integer (int64) > array

standardLaborPlan
optional

< LaborPlanItem > array

3.21. LaborPlanItem

Name Schema

basis
optional

enum (item, lot)

laborPlanningTypeId
optional

integer (int64)

time
optional

integer (int64)

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

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.23. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.24. Links

Name Schema

empty
optional

boolean

3.25. 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.26. 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.27. PlannedUnit

Name Schema

machinePlan
optional

LaborPlan

peoplePlan
optional

LaborPlan

unitId
optional

integer (int64)

3.28. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.29. 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.30. 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)

isSerialized
optional

Is Serialized

boolean

name
optional

Name of the Product

string

3.31. PropertyValues

Name Schema

propertyDefinitionId
optional

string

propertyValue
optional

string

3.32. Substitution

Name Schema

conversionFactor
optional

number (double)

productCode
optional

string

productDescription
optional

string

productId
optional

integer (int64)

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

substitutionOrder
optional

integer (int32)

uom
optional

integer (int64)

uomCode
optional

string

uomDescription
optional

string

3.33. TabConfigData

Name Schema

authentication
optional

boolean

enable_seriallot
optional

boolean

external_url
optional

string

tab_input_parameters
optional

< InputParamterRequest > array

3.34. TabConfigExpressions

Type : object

3.35. 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.36. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

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

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.

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.38. UnitCollection

Name Schema

collection
optional

CollectionMetadata

content
optional

< Unit > array

links
optional

< Link > array

3.39. 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.40. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.41. 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.42. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

3.43. WorkOrder

Work order Data transfer object

Name Description Schema

cancelledOn
optional

Date that the work order was cancelled.

string (date-time)

completedBy
optional

The user that completed the work order.

string

completedOn
optional

Date that the work order was completed.

string (date-time)

createdBy
optional

User that created the work order.

string

createdOn
optional

Date that the work order was created.

string (date-time)

eTagValue
optional

Current ETag value of the work order resource

string

id
optional

Work Order ID.

integer (int64)

lastModifiedBy
optional

User that last modified the work order.

string

lastModifiedOn
optional

Date that the work order was last modified.

string (date-time)

name
optional

Work Order name.

string

plannedEndDate
optional

Planned end date for the work order.

string (date-time)

plannedQuantity
optional

The planned quantity to produce with this work order.

integer (int32)

plannedStartDate
optional

Planned start date for the work order.

string (date-time)

priority
optional

Relative priority of the work order.

integer (int32)

processOrderId
optional

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

integer (int64)

producedMaterialId
optional

Work order produced material ID.

integer (int64)

productionLineId
optional

Work order production line ID.

integer (int64)

readyOn
optional

Date that the work order was made ready.

string (date-time)

routeDefinitionId
optional

Refers to the route used to execute the work order.

integer (int64)

startedOn
optional

Date that the work order was started.

string (date-time)

status
optional

Status of the work order.

string

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

page
optional

PageMetadata

3.45. WorkOrderSegmentDefinitionInfo

Name Schema

bomFormulation
optional

BomFormulation

bomFormulationId
optional

integer (int64)

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

object

structureType
optional

string

3.46. WorkOrderSegmentInfo

Segments data transfer object

Name Description Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

dataEntryPlans
optional

< integer (int64) > array

description
optional

string

documents
optional

< Document > array

formulationItemsConsumption
optional

< FormulationItemsConsumption > array

name
optional

string

plannedUnits
optional

< PlannedUnit > array

propertyValues
optional

< PropertyValues > array

segmentId
optional

integer (int64)

segmentOnHold
optional

boolean

segmentType
optional

enum (group, route, segment)

sequenceNumber
optional

Sequence Number of the Segment

integer (int32)

status
optional

Status of the segment derived from segment actuals

string

suggestedLaborTypes
optional

< integer (int64) > array

toolCategoryIds
optional

< integer (int64) > array

toolIds
optional

< integer (int64) > array

3.47. 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 : https://localhost/uaa/oauth/authorize
Token URL : https://localhost/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.