1. Overview

The service contains a collection of RESTful service calls relating to Process Order from the Plant apps serverDescriptions of these functions can be found in the section headers for each collection of relevant resources.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • comment-controller : Comment Controller

  • execution-path-controller : Execution Path Controller

  • monitoring-controller : Monitoring Controller

  • process-order-status-controller : Process Order Status Controller

  • production-scheduler-controller : Production Scheduler Controller

  • property-controller : Property Controller

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Comment-controller

Comment Controller

2.1.1. Add a comment

POST /comments
Parameters
Type Name Description Schema

Query

orderId
required

Order id to which comment needs to be added

integer (int64)

Body

commentCreateInfo
required

Comment Create Info

CommentCreateInfo
Responses
HTTP Code Description Schema

200

Ok

CommentInfo

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

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

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get the history of comments for the given order id

GET /comments
Parameters
Type Name Description Schema

Query

orderId
required

Order id for which comments are required

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

< CommentInfo > array

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. Get the details of a comment

GET /comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
required

commentId

integer (int64)

Query

orderId
required

Order id for which comment is required

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

CommentInfo

401

Unauthorized

No Content

404

Not Found

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Update a comment

PUT /comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
required

commentId

integer (int64)

Query

orderId
required

Order id to which this comment belongs to

integer (int64)

Body

commentUpdateInfo
required

Comment Update Info

CommentCreateInfo
Responses
HTTP Code Description Schema

200

Ok

CommentInfo

401

Unauthorized

No Content

403

Forbidden

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

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

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Delete the Process Order comment

DELETE /comments/{commentId}
Parameters
Type Name Description Schema

Path

commentId
required

commentId

integer (int64)

Query

orderId
required

Order id to which this comment belongs to

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Execution-path-controller

Execution Path Controller

2.2.1. Get paths

GET /api/paths
Parameters
Type Name Description Schema

Query

lineIds
optional

Comma separated list of Production line ids

string
Responses
HTTP Code Description Schema

200

OK

< ExecutionPathExtendedResource > array

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.2. Get product details for the path

GET /api/paths/{pathId}/products
Parameters
Type Name Description Schema

Path

pathId
required

path id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< PathProductInfo > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.3. Get Bom details for the path product

GET /api/paths/{pathId}/products/{productId}/boms
Parameters
Type Name Description Schema

Path

pathId
required

path id

integer (int64)

Path

productId
required

prod id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< IdNameValue > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Monitoring-controller

Monitoring Controller

2.3.1. Fetches status for proficy message bridge

GET /monitoring-viewer/messageBridgeStatus
Responses
HTTP Code Description Schema

200

OK

Resource«ServiceHealthStatus»

204

No Content, no service exists

Resource«ServiceHealthStatus»

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.2. Fetches status for proficy message bridge

GET /monitoring-viewer/messagingStatus
Responses
HTTP Code Description Schema

200

OK

Resource«ServiceHealthStatus»

204

No Content, no service exists

Resource«ServiceHealthStatus»

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.3. Fetches status for rabbit mq

GET /monitoring-viewer/rmqStatus
Responses
HTTP Code Description Schema

200

OK

Resource«ServiceHealthStatus»

204

No Content, no service exists

Resource«ServiceHealthStatus»

401

Unauthorized

No Content

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. Process-order-status-controller

Process Order Status Controller

2.4.1. Get All process Order Statuses based on filter Params

GET /api/processOrders/statuses
Parameters
Type Name Description Schema

Query

status
optional

search by process order status name.

string

Query

statusIds
optional

List of comma separated status Ids

string
Responses
HTTP Code Description Schema

200

OK

< ProcessOrderStatusDetails > array

401

Unauthorized

No Content

403

Forbidden

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.4.2. Update process Order Status, statusGroup can be set to Open or Close for the status to be displayed in Open or Close tab. Sorting Order can be set to any integer. Its a relative value

PUT /api/processOrders/statuses/{statusId}
Parameters
Type Name Description Schema

Path

statusId
optional

StatusId of the status

integer (int64)

Body

statusUpdateDetails
required

Body for updating status

StatusUpdateDetails
Responses
HTTP Code Description Schema

200

OK

ProcessOrderStatusDetails

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Consumes

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

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Production-scheduler-controller

Production Scheduler Controller

2.5.1. Creates process orders

POST /api/processOrders
Parameters
Type Name Description Schema

Body

processOrderCreateDetails
required

Body for creating process order

ProcessOrderCreateDetails
Responses
HTTP Code Description Schema

201

Created

ProcessOrder

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

409

Conflict

No Content

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

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

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.2. Get a collection of process orders based on filter set

GET /api/processOrders
Parameters
Type Name Description Schema Default

Query

dateFilterOn
optional

Column to which date Filter is to be applied, default = PlannedTime. if PlannedTime is passed then it will be applied on Planned Start Time And if ActualTime is passed then it will be applied on first non null value of [ActualEndTime,ActualStartTime,EntyOn]

enum (PlannedTime, ActualTime)

"PlannedTime"

Query

endTime
optional

End time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

includeUnboundedPOs
optional

Include Unbounded Process Order, [0 - Exclude Unbounded PO in response], [1 to include it] and 2 to just include Unbounded POs and exclude bonded ones. Default value is zero

integer (int32)

0

Query

lineIds
optional

Comma separated list of Production line ids

string

Query

page
optional

Results page number to retrieve

integer (int32)

Query

pathIds
optional

Comma separated list of path ids

string

Query

pathName
optional

search by path name.

string

Query

processOrderName
optional

search by process order name.

string

Query

prodCode
optional

search by product code.

string

Query

size
optional

Number of records per page, from 1 to 500

integer (int32)

Query

startTime
optional

Start time in ISO-8601 format (YYYY-MM-DDThh:mm:ssZ), in case of custom time selection.

string (date-time)

Query

statuses
optional

Comma separated list of statuses. It can either be comma separated list of statusIds like -1,2,3,4 Or comma separated list of status Names like Active,Pending.

If mixture of both is provided then it will be considered as status names list because Status names may have numeric value.

It is recommended to use the comma separated list of statusIds

string
Responses
HTTP Code Description Schema

200

Success

ProcessOrderPage

401

Unauthorized

No Content

403

Forbidden

No Content
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.3. Get a process order’s history. This will return paginated po history response. V1 API is not paginated

GET /api/processOrders/v2/{processOrderId}/history
Parameters
Type Name Description Schema

Path

processOrderId
required

Process order id

integer (int64)

Query

page
optional

Results page number to retrieve

integer (int32)

Query

size
optional

Number of records per page, from 1 to 500

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProcessOrderHistoryPage

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.4. Get a process order

GET /api/processOrders/{orderId}
Parameters
Type Name Description Schema

Path

orderId
required

Process order id

integer (int64)
Responses
HTTP Code Description Schema

200

Success

ProcessOrder

401

Unautorized

No Content

403

Forbidden

No Content

404

Not found

No Content
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.5. Update a process order

PUT /api/processOrders/{orderId}
Parameters
Type Name Description Schema

Path

orderId
required

Process order id

integer (int64)

Body

processOrderUpdateDetails
required

Body for updating process order

ProcessOrderCreateDetails
Responses
HTTP Code Description Schema

200

OK

ProcessOrder

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

No Content

422

Unprocessable Entity

HttpErrorResponse
Consumes

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

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.6. Delete a process order

DELETE /api/processOrders/{orderId}
Parameters
Type Name Description Schema

Path

orderId
required

Process order id to be deleted

integer (int64)
Responses
HTTP Code Description Schema

204

No Content

object

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.7. add process order StartOn unit

POST /api/processOrders/{orderId}/StartOnUnit
Parameters
Type Name Description Schema

Path

orderId
required

Process orderId which needs to be started on unit

integer (int64)

Body

unit
required

UnitId on which this Process order needs to be started, Id is the required field

IdNameValue
Responses
HTTP Code Description Schema

200

OK

ProcessOrderUnitStartInfoResource

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Consumes

  • application/json

Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.8. get process order StartOn unit

GET /api/processOrders/{orderId}/StartOnUnit
Parameters
Type Name Description Schema

Path

orderId
required

Process orderId which needs to be started on unit

integer (int64)

Query

orderStartId
optional

Process Order startId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ProcessOrderUnitStartInfoResources

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.9. Get BOM Details for the process order

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

Path

orderId
required

process order id

integer (int64)

Query

targetLotId
optional

targetLotId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialInfo > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.10. Consumption details for the item

GET /api/processOrders/{orderId}/boms/{itemId}/consumptions
Parameters
Type Name Description Schema

Path

itemId
required

itemId

integer (int64)

Path

orderId
required

process order id

integer (int64)

Query

targetLotId
optional

targetLotId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ItemConsumptionRecord > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.11. Get materials for the process order

GET /api/processOrders/{orderId}/materials
Parameters
Type Name Description Schema

Path

orderId
required

process order id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< MaterialInfo > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.12. Get process order history

GET /api/processOrders/{processOrderId}/history
Caution

operation.deprecated
Parameters
Type Name Description Schema

Path

processOrderId
required

Process order id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ProcessOrderHistory > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.13. Get next available units for the process order, Will be applicable for those process orders whose flow is controlled independently

GET /api/processOrders/{processOrderId}/nextAvailableUnits
Parameters
Type Name Description Schema

Path

processOrderId
required

Process order id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< IdNameValue > array

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse
Produces

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Property-controller

Property Controller

2.6.1. Get all revisions for property-group-definition

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

Path

initialId
required

initialId

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.6.2. Get all property groups list

GET /api/properties/groups
Parameters
Type Name Description Schema Default

Query

categoryId
optional

categoryId

string

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

200
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.6.3. Get property group by property group id

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

Path

groupId
required

groupId

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.6.4. Get all property definitions by property group id

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

Path

groupId
required

groupId

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.6.5. Get all property definitions value for given process order

GET /api/properties/{processOrderId}/propertyValues
Parameters
Type Name Description Schema Default

Path

processOrderId
required

processOrderId

integer (int64)

Query

pageNo
optional

pageNo

integer (int32)

0

Query

pageSize
optional

pageSize

integer (int32)

200
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.6.6. Change all property definitions for given process order

PUT /api/properties/{processOrderId}/propertyValues
Parameters
Type Name Description Schema

Path

processOrderId
required

processOrderId

integer (int64)

Body

propertyCreateDetailsList
required

Body for creating process order property. Valid values for 'level' field are STANDARD, CUSTOM and USERDEFINED

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

User Settings Controller

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

3. Definitions

3.1. CommentCreateInfo

Name Schema

commentId
optional

integer (int64)

commentText
optional

string

3.2. CommentInfo

Name Description Schema

commentId
optional

Id for Comment

integer (int64)

commentText
optional

Comment Content

string

commentTime
optional

string (date-time)

threadId
optional

integer (int64)

user
optional

IdNameValue

3.3. Error

Name Schema

code
optional

string

details
optional

object

3.4. ExecutionPathExtendedResource

Name Description Schema

code
optional

Customer Code for the path

string

commentsThreadId
optional

The Comments Thread Id of the path record. Points to a chain of comments.

integer (int64)

description
optional

Path Description

string

isLineProduction
optional

Production on this path should count towards line production
Example : false

boolean

isScheduleControlled
optional

The execution path is controlled by a schedule
Example : false

boolean

lineId
optional

The production line id of this path

integer (int64)

lineProduction
optional

Example : false

boolean

links
optional

< Link > array

pathId
optional

Unique Id of the path record

integer (int64)

pathUnits
optional

The pathUnits associated with this path

< ExecutionPathUnitInfo > array

permissions
optional

< Permission > array

products
optional

Available products for this path

< PathProductInfo > array

scheduleControlType
optional

The schedule control type setting

enum (AllUnitsRunSameScheduleSimultaneously, ScheduleFlowsByEvent, ScheduleFlowsIndependently)

scheduleControlled
optional

Example : false

boolean

3.5. ExecutionPathUnitInfo

Name Description Schema

executionPathUnitId
optional

Unique Id of the Execution Path Unit record

integer (int64)

isProductionPoint
optional

Is this unit the production counting unit of the path
Example : false

boolean

isSchedulePoint
optional

Is this unit the scheduling unit of the path
Example : false

boolean

pathId
optional

The Path Id of the path this unit is a member of

integer (int64)

unitId
optional

The production unit id

integer (int64)

unitOrder
optional

The execution order of this unit in the path

integer (int32)

3.6. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.7. IdNameValue

Name Description Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.8. ItemConsumptionRecord

Name Description Schema

bomItemId
optional

bomItemId

integer (int64)

consumedQuantity
optional

consumedQuantity

number (double)

id
optional

Event components id

integer (int64)

lotIdentifier
optional

Source lotIdentifier

string

quantityPrecision
optional

quantityPrecision

integer (int32)

sourceMaterialLotId
optional

sourceMaterialLotId

integer (int64)

targetMaterialLotId
optional

targetMaterialLotId

integer (int64)

timeStamp
optional

Time stamp for the consumption

string (date-time)

unitOfMeasure
optional

Unit Of Measure of the BOM Item

string

unitOfMeasureId
optional

unitOfMeasureId

integer (int64)

userId
optional

User Id of the user who made the consumption

integer (int64)

userName
optional

User Name of the user who made the consumption

string

3.9. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.10. MaterialInfo

Name Schema

actualQuantity
optional

number (double)

actualQuantityColorFlag
optional

integer (int32)

bOMFormulationId
optional

integer (int64)

bOMFormulationItemId
optional

integer (int64)

backColor
optional

integer (int64)

bomformulationId
optional

integer (int64)

bomformulationItemId
optional

integer (int64)

colorFlag
optional

integer (int64)

engineeringUnits
optional

string

itemOrder
optional

integer (int32)

location
optional

string

lotNumber
optional

string

lowerReject
optional

number (double)

lowerTolerancePrecision
optional

integer (int32)

pUId
optional

integer (int64)

prodCode
optional

string

prodDesc
optional

string

prodId
optional

integer (int64)

puid
optional

integer (int64)

quantityPer
optional

number (double)

quantityPrecision
optional

integer (int32)

remainingQuantity
optional

number (double)

requiredQuantity
optional

number (double)

scrapFactor
optional

number (double)

substitutions
optional

integer (int64)

upperReject
optional

number (double)

upperTolerancePrecision
optional

integer (int32)

useEventComponents
optional

integer (int32)

3.11. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.12. PathProductInfo

Name Description Schema

productCode
optional

Descriptive Name of Product record

string

productDescription
optional

Code Name of Product record

string

productId
optional

Unique Id of the Product record record

integer (int64)

3.13. Permission

Name Description Schema

permissionName
optional

string

permissionValue
optional

Example : false

boolean

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

Name Description Schema

actualBadItems
optional

actual Bad Items of product this process order has produced

integer (int64)

actualBadQuantity
optional

actual Bad Quantity of product this process order has produced

number (double)

actualDownTime
optional

Downtime while this PO is active

number (double)

actualEndTime
optional

Actual endTime for this PO

string (date-time)

actualGoodItems
optional

actual good Items of product this process order has produced

integer (int64)

actualGoodQuantity
optional

actual good Quantity of product this process order has produced

number (double)

actualRepetitions
optional

actualRepetitions

integer (int64)

actualRunningTime
optional

Time for which this process order has ran

number (double)

actualStartTime
optional

Actual startTime for this PO

string (date-time)

adjustedQuantity
optional

Adjusted quantity of product for this process order

number (double)

alarmCount
optional

alarms raised on this PO

integer (int64)

allowedStatusTransition
optional

Allowed state changes from the current status of this process order

< string > array

blockNumber
optional

blockNumber

string

bomFormulation
optional

Specifies the BOM Formulation for the process order

IdNameValue

commentsThreadId
optional

The Comments Thread Id of the process order record. Points to a chain of comments.

integer (int64)

controlType
optional

Specifies the control type of the process order

enum (QUANTITY, DURATION, TIME)

engineeringUnit
optional

engineeringUnit

string

entryOn
optional

last modified date

string (date-time)

extendedInfo
optional

extendedInfo

string

impliedSequence
optional

Execution sequence is normally by planned start, but this can override the sequence

integer (int64)

impliedSequenceOffset
optional

impliedSequenceOffset

integer (int64)

lateItems
optional

lateItems

integer (int64)

line
optional

The line associated with process order

IdNameValue

links
optional

< Link > array

orderType
optional

Specifies the type of the order (Production Plan Type)

enum (SCHEDULE, REWORK)

parentProductionPlanId
optional

Id for this process order’s parent process order if any

integer (int64)

participatingUnits
optional

Information regarding the PO start and end on involved units. Will be used for process orders whose flow is [Schedule Flows independently]

< ProcessOrderUnitStartInfo > array

path
optional

The Path this process order uses

IdNameValue

plannedEndTime
optional

The planned time to finish the order, corresponds to the forecastedEndTime in db

string (date-time)

plannedQuantity
optional

Quantity of product this process order is requesting, corresponds to the forecastedQuantity in db

number (double)

plannedStartTime
optional

The planned time to start the order, corresponds to the forecastedStartTime in db

string (date-time)

predictedRemainingDuration
optional

predictedRemainingDuration for this process order

number (double)

predictedRemainingQuantity
optional

predictedRemainingQuantity of product for this process order

number (double)

predictedTotalDuration
optional

predictedTotalDuration for this process order

number (double)

processOrder
optional

Descriptive Name of the process order

string

processOrderId
optional

Unique Id of the process order record

integer (int64)

product
optional

the product this process order is requesting

IdNameValue

productionRate
optional

Production rate of this product

number (double)

schedulePointUnit
optional

The unit associated with process order

IdNameValue

sourceProductionPlanId
optional

Id for this process order’s source process order if any

integer (int64)

status
optional

The status of the process order

string

userGeneral1
optional

userGeneral1

string

userGeneral2
optional

userGeneral2

string

userGeneral3
optional

userGeneral3

string

3.16. ProcessOrderCreateDetails

Name Description Schema

blockNumber
optional

string

bomFormulationId
optional

integer (int64)

commentId
optional

integer (int64)

controlType
optional

enum (QUANTITY, DURATION, TIME)

extendedInfo
optional

string

pathId
optional

integer (int64)

plannedEndTime
optional

string (date-time)

plannedStartTime
optional

string (date-time)

processOrderName
optional

string

processOrderPriority
optional

Will be used to reorder process orders, In PO update. Only +1/-1 values allowed for now

integer (int32)

processOrderType
optional

Can be of two types only, Schedule Type and rework type. Rework is not supported yet.

enum (SCHEDULE, REWORK)

prodId
optional

integer (int64)

productionRate
optional

number (double)

quantity
optional

number (double)

sourceProcessOrderId
optional

integer (int64)

status
optional

Use this for updating Process Order status, will be ignored while creation of process order.

string

userGeneral1
optional

string

userGeneral2
optional

string

userGeneral3
optional

string

3.17. ProcessOrderHistory

Name Description Schema

actualBadItems
optional

integer (int64)

actualBadQuantity
optional

actual Bad Quantity of product this process order has produced

number (double)

actualDowntime
optional

number (double)

actualEndTime
optional

string (date-time)

actualGoodItems
optional

integer (int64)

actualGoodQuantity
optional

actual good Quantity of product this process order has produced

number (double)

actualRepetitions
optional

integer (int64)

actualRunningTime
optional

number (double)

actualStartTime
optional

string (date-time)

adjustedQuantity
optional

Actual quantity of product this process order has produced

number (double)

alarmCount
optional

integer (int64)

blockNumber
optional

string

bomFormulation
optional

IdNameValue

changeTime
optional

string (date-time)

controlType
optional

enum (QUANTITY, DURATION, TIME)

extendedInfo
optional

string

forecastEndDate
optional

string (date-time)

forecastQuantity
optional

forecast Quantity of product for this process order

number (double)

forecastStartDate
optional

string (date-time)

impliedSequence
optional

integer (int64)

lateItems
optional

integer (int64)

path
optional

IdNameValue

plannedQuantity
optional

Quantity of product this process order is requesting

number (double)

predictedRemainingDuration
optional

number (double)

predictedRemainingQuantity
optional

predictedRemainingQuantity of product for this process order

number (double)

predictedTotalDuration
optional

number (double)

processOrder
optional

string

processOrderId
optional

integer (int64)

processOrderType
optional

enum (SCHEDULE, REWORK)

product
optional

IdNameValue

productionRate
optional

number (double)

sourceProcessOrder
optional

IdNameValue

status
optional

string

transactionType
optional

enum (Insert, Update, Delete)

user
optional

string

userGeneral1
optional

string

userGeneral2
optional

string

userGeneral3
optional

string

3.18. ProcessOrderHistoryPage

Name Schema

content
optional

< ProcessOrderHistoryResource > array

links
optional

< Link > array

page
optional

PageMetadata

3.19. ProcessOrderHistoryResource

Name Description Schema

actualBadItems
optional

integer (int64)

actualBadQuantity
optional

actual Bad Quantity of product this process order has produced

number (double)

actualDowntime
optional

number (double)

actualEndTime
optional

string (date-time)

actualGoodItems
optional

integer (int64)

actualGoodQuantity
optional

actual good Quantity of product this process order has produced

number (double)

actualRepetitions
optional

integer (int64)

actualRunningTime
optional

number (double)

actualStartTime
optional

string (date-time)

adjustedQuantity
optional

Actual quantity of product this process order has produced

number (double)

alarmCount
optional

integer (int64)

blockNumber
optional

string

bomFormulation
optional

IdNameValue

changeTime
optional

string (date-time)

controlType
optional

enum (QUANTITY, DURATION, TIME)

extendedInfo
optional

string

forecastEndDate
optional

string (date-time)

forecastQuantity
optional

forecast Quantity of product for this process order

number (double)

forecastStartDate
optional

string (date-time)

impliedSequence
optional

integer (int64)

lateItems
optional

integer (int64)

links
optional

< Link > array

path
optional

IdNameValue

plannedQuantity
optional

Quantity of product this process order is requesting

number (double)

predictedRemainingDuration
optional

number (double)

predictedRemainingQuantity
optional

predictedRemainingQuantity of product for this process order

number (double)

predictedTotalDuration
optional

number (double)

processOrder
optional

string

processOrderId
optional

integer (int64)

processOrderType
optional

enum (SCHEDULE, REWORK)

product
optional

IdNameValue

productionRate
optional

number (double)

sourceProcessOrder
optional

IdNameValue

status
optional

string

transactionType
optional

enum (Insert, Update, Delete)

user
optional

string

userGeneral1
optional

string

userGeneral2
optional

string

userGeneral3
optional

string

3.20. ProcessOrderPage

Name Schema

content
optional

< ProcessOrder > array

links
optional

< Link > array

page
optional

PageMetadata

3.21. ProcessOrderStatusDetails

Name Description Schema

allowEdit
optional

integer (int64)

colour
optional

Status Colour in Hex format

string

movable
optional

integer (int64)

statusDescription
optional

string

statusDescriptionLocal
optional

string

statusGroup
optional

PO Status Group for UI display Grid, current Groups supported from UI are - Open, Close

string

statusId
optional

integer (int64)

statusSortOrder
optional

PO Status Order [ASCENDING] for UI display Grid

integer (int64)

3.22. ProcessOrderUnitStartInfo

Name Description Schema

endTime
optional

PO end time on this unit

string (date-time)

isProductionPoint
optional

Example : false

boolean

processOrderId
optional

integer (int64)

processOrderUnitStartId
optional

integer (int64)

productionPlanSetupId
optional

Production plan setup id for this record

integer (int64)

startTime
optional

PO start time on this unit

string (date-time)

unit
optional

IdNameValue

3.23. ProcessOrderUnitStartInfoResource

Name Description Schema

endTime
optional

PO end time on this unit

string (date-time)

isProductionPoint
optional

Example : false

boolean

links
optional

< Link > array

processOrderId
optional

integer (int64)

processOrderUnitStartId
optional

integer (int64)

productionPlanSetupId
optional

Production plan setup id for this record

integer (int64)

startTime
optional

PO start time on this unit

string (date-time)

unit
optional

IdNameValue

3.24. ProcessOrderUnitStartInfoResources

Name Schema

content
optional

< ProcessOrderUnitStartInfo > array

links
optional

< Link > array

3.25. PropertyCreateDetails

Name Schema

id
optional

string

level
optional

string

name
optional

string

value
optional

string

3.26. Resource«ServiceHealthStatus»

Name Description Schema

isRunning
optional

The status of the service. Returns true if running, else false
Example : false

boolean

links
optional

< Link > array

reason
optional

Reason why the service is not running. Returned only when the service is down and if there is a reason for failure

string

3.27. ServiceHealthStatus

Name Description Schema

isRunning
optional

The status of the service. Returns true if running, else false
Example : false

boolean

reason
optional

Reason why the service is not running. Returned only when the service is down and if there is a reason for failure

string

3.28. StatusUpdateDetails

Name Description Schema

statusGroup
optional

PO Status Group for UI display Grid, current Groups supported from UI are - Open, Close

string

statusOrder
optional

PO Status Order [ASCENDING] for UI display Grid

integer (int32)

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

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.