1. Overview

The service contains a collection of RESTful service calls to retrieve and update Waste management domain related information in PA relevant to manufacturing execution.

Descriptions 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

  • comments-controller : Comments Controller

  • monitoring-controller : Monitoring Controller

  • time-selection-controller : Time Selection Controller

  • user-settings-controller : User Settings Controller

  • waste-event-controller : Waste Event Controller

  • waste-events-viewer-controller : Waste Events Viewer Controller

2. Resources

2.1. Comments-controller

Comments Controller

2.1.1. Add a comment

POST /wasteEvents/comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (WasteCause, WasteAction)

Query

wasteEventId
optional

id of the entity to which comments are to be added, it can be wasteEventId.

integer (int64)

Body

commentInfo
required

commentInfo

CommentInfo
Responses
HTTP Code Description Schema

200

Ok

CommentInfo

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

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

GET /wasteEvents/comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (WasteCause, WasteAction)

Query

wasteEventId
required

id of the entity for which comments are required waste event id.

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

Security
Type Name Scopes

oauth2

oauth

default

2.1.3. Update a comment

PUT /wasteEvents/comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (WasteCause, WasteAction)

Query

wasteEventId
required

WasteEventId of the entity of which comment is to be updated

integer (int64)

Body

commentInfo
required

commentInfo

CommentInfo
Responses
HTTP Code Description Schema

200

Ok

CommentInfo

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.4. Get the details of a comment

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

Path

commentId
required

commentId

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (WasteCause, WasteAction)

Query

rootId
required

id of the entity for which comment is required, it can be wasteEventId.

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

Security
Type Name Scopes

oauth2

oauth

default

2.1.5. Delete the waste event comment

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

Path

commentId
required

commentId

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (WasteCause, WasteAction, NonProductiveDetail)

Query

rootId
required

id of the entity Of whose comment is to be deleted, it can be waste event Id

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

object

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Service Unavailable

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2. Monitoring-controller

Monitoring Controller

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

oauth

default

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

oauth

default

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

oauth

default

2.3. Time-selection-controller

Time Selection Controller

2.3.1. Fetch the timerange based on the selected timeselection

GET /time-selection
Parameters
Type Name Description Schema

Query

equipmentId
optional

Comma separated unit ids

< string > array(multi)

Query

equipmentType
optional

Type of the equipment - 1 for Units and 2 for Lines. Based on equipmentType it will either return Unit based Kpi or Line based Kpi for the specified unitIds

integer (int32)

Query

timeSelection
required

Time selection values
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
7 - Custom
8 - Current Shift
9 - Previous Shift
10- Next Shift
11 - All(Current Day, Prev Day, Current Week, Prev Week, Next Week)

integer (int32)
Responses
HTTP Code Description Schema

200

No Content

TimeSelectionResource
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.4. User-settings-controller

User Settings Controller

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

oauth

default

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

oauth

default

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

oauth

default

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

oauth

default

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

oauth

default

2.5. Waste-event-controller

Waste Event Controller

2.5.1. Create Waste Event

POST /wasteEvents
Parameters
Type Name Description Schema

Query

creationType
required

creationType

enum (TimeBasedWasteEvent, ProductionBasedWasteEvent)

Body

wasteEventForCreate
required

wasteEventForCreate

WasteEventForCreate
Responses
HTTP Code Description Schema

200

OK

WasteEventResponse

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

oauth

default

2.5.2. Copy Waste Event Reasons

POST /wasteEvents/copyReasons
Parameters
Type Name Description Schema

Body

copyReasonsForUpdate
required

copyReasonsForUpdate

CopyReasonsForUpdate
Responses
HTTP Code Description Schema

200

OK

< WasteEventResponse > array

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

oauth

default

2.5.3. Update waste event

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

Path

id
required

id

integer (int64)

Body

wasteEventForUpdate
required

wasteEventForUpdate

WasteEventForUpdate
Responses
HTTP Code Description Schema

200

OK

WasteEventResponse

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

oauth

default

2.5.4. delete waste event

DELETE /wasteEvents/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

204

No Content

WasteEventResponse

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

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

Security
Type Name Scopes

oauth2

oauth

default

2.6. Waste-events-viewer-controller

Waste Events Viewer Controller

2.6.1. Get all waste events

GET /wasteEventsViewer
Parameters
Type Name Description Schema

Query

associatedProductionEventId
optional

To filter waste events for a Production Event

integer (int64)

Query

endTime
optional

End time (incase of timeSelection = 7) in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

includeProductionEventBased
optional

Whether to include production event based waste events. By default would include

boolean

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

Query

startTime
optional

Start time (incase of timeSelection = 7) in ISO 8601 format (yyyy-MM-dd’T’HH:mm:ss.SSSZ)

string (date-time)

Query

timeSelection
required

timeSelection

enum (currentDay, prevDay, currentWeek, prevWeek, nextWeek, nextDay, custom, currentShift, previousShift, nextShift)

Query

unitIds
required

List of Unit Ids, Can also set comma seperated unit ids for this property

string
Responses
HTTP Code Description Schema

200

OK

object

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.6.2. Fetches departments,lines and units information

GET /wasteEventsViewer/departments
Parameters
Type Name Description Schema Default

Query

expandLines
optional

Flag specifying whether lines information needs to be included under departments

boolean

"true"

Query

expandUnits
optional

Flag specifying whether units information needs to be included under lines

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

< DepartmentInfo > array

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by the application

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.3. Get all Waste Event Faults

GET /wasteEventsViewer/faults
Parameters
Type Name Description Schema

Query

sourceUnitId
optional

sourceUnitId to get WasteFault Details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< FaultInfo > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.6.4. Get locations info

GET /wasteEventsViewer/locations
Parameters
Type Name Description Schema

Query

masterUnitId
required

masterUnitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

LocationInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by the application

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.5. Get waste measurements

GET /wasteEventsViewer/measurements
Parameters
Type Name Description Schema

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< WasteMeasurementRecord > array

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

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

Security
Type Name Scopes

oauth2

oauth

default

2.6.6. Get permissions info

GET /wasteEventsViewer/permissions
Parameters
Type Name Description Schema

Query

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

PermissionsResponse

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by the application

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.7. Get ProductionEvents info

GET /wasteEventsViewer/productionEvents
Parameters
Type Name Description Schema

Query

endTime
optional

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

string (date-time)

Query

eventName
optional

Event Name

string

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

Query

startTime
optional

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

string (date-time)

Query

timeSelection
required

timeSelection

enum (currentDay, prevDay, currentWeek, prevWeek, nextWeek, nextDay, custom, currentShift, previousShift, nextShift)

Query

unitIds
optional

List of Unit Ids, Can also set comma seperated unit ids for this property

string
Responses
HTTP Code Description Schema

200

OK

object

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

oauth

default

2.6.8. Get all Waste Event Types

GET /wasteEventsViewer/types
Responses
HTTP Code Description Schema

200

OK

< WasteEventTypeRecord > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.6.9. Get Waste Event Type

GET /wasteEventsViewer/types/{id}
Parameters
Type Name Description Schema

Path

id
optional

id to get WasteEventType Details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WasteEventTypeRecord

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

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

Security
Type Name Scopes

oauth2

oauth

default

2.6.10. Fetches unit preferences for the given waste event state

GET /wasteEventsViewer/unit-preferences
Responses
HTTP Code Description Schema

200

OK

UnitInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by waste Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.11. Fetches reasons and fault information for the given unit Id

GET /wasteEventsViewer/units/{unitId}/machineData
Parameters
Type Name Description Schema Default

Path

unitId
required

Unit id for which reasons and faults information needs to be fetched

integer (int64)

Query

expandFaults
optional

Flag to indicate whether faults information should be included in the response

boolean

"true"

Query

expandReasons
optional

Flag to indicate whether reasons information should be included in the response

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

WasteEventCreatorMachineData

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by the application

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.12. Get waste event by id

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

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WasteEventResponse

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

oauth

default

2.6.13. Get waste event History records

GET /wasteEventsViewer/{wasteId}/history
Parameters
Type Name Description Schema

Path

wasteId
required

Waste Event id to get history records

integer (int64)
Responses
HTTP Code Description Schema

200

OK

WasteEvent

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

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

Security
Type Name Scopes

oauth2

oauth

default

3. Definitions

3.1. AssetInfo

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

name
optional

Name of the asset

string

3.2. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.3. CollectionResource«ReasonHeaderInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonHeaderInfo > array

links
optional

< Link > array

3.4. CollectionResource«ReasonInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonInfo > array

links
optional

< Link > array

3.5. CommentInfo

Name Description Schema

commentId
optional

The Id of the comment record.

integer (int64)

commentText
optional

comment text

string

commentTime
optional

comment creation time

string (date-time)

threadId
optional

Id of the Thread the comment belongs to.

integer (int64)

user
optional

comment owner

IdNameValue

3.6. CopyReasonsForUpdate

Name Schema

destinationWasteEvents
optional

< integer (int64) > array

sourceWasteEvent
optional

integer (int64)

3.7. DepartmentInfo

Name Schema

assetId
optional

integer (int64)

lines
optional

< Resource«LineInfo» > array

name
optional

string

type
optional

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

3.8. Error

Name Schema

code
optional

string

details
optional

object

3.9. FaultInfo

Name Description Schema

faultId
optional

Fault Id

integer (int64)

name
optional

Fault Name

string

reason1
optional

Reason1 Information

ReasonInfo

reason2
optional

Reason2 Information

ReasonInfo

reason3
optional

Reason3 Information

ReasonInfo

reason4
optional

Reason4 Information

ReasonInfo

3.10. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.11. IdNameValue

Name Description Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.12. LineInfo

Name Schema

assetId
optional

integer (int64)

name
optional

string

type
optional

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

units
optional

< Resource«UnitInfo» > array

3.13. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

rel
optional

string

templated
optional

boolean

title
optional

string

type
optional

string

3.14. LocationInfo

Name Description Schema

locations
optional

Locations for master unit

< AssetInfo > array

masterUnitId
optional

Master unit id

integer (int64)

masterUnitName
optional

Master unit name

string

3.15. PermissionsResponse

Name Description Schema

permissions
optional

permissions

< string, boolean > map

3.16. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.17. ReasonHeaderInfo

Name Description Schema

levelName
optional

Reason level name

string

reasonLevel
optional

Reason level

integer (int32)

3.18. ReasonInfo

Name Description Schema

categoryId
optional

Downtime Category Id

integer (int64)

categoryName
optional

Downtime Category Name

string

children
optional

Child Reason Information

< ReasonInfo > array

commentRequired
optional

boolean

nodeId
optional

Reason Node Id

integer (int64)

parentNodeId
optional

Reason Parent Node Id

integer (int64)

reasonId
optional

Reason Id

integer (int64)

reasonName
optional

Reason Name

string

treeId
optional

Reason Tree Id

integer (int64)

3.19. Resource«LineInfo»

Name Schema

assetId
optional

integer (int64)

links
optional

< Link > array

name
optional

string

type
optional

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

units
optional

< Resource«UnitInfo» > array

3.20. 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.21. Resource«TopNReasonInfo»

Name Description Schema

level1
optional

Reason Information Level 1

ReasonInfo

level2
optional

Reason Information Level 2

ReasonInfo

level3
optional

Reason Information Level 3

ReasonInfo

level4
optional

Reason Information Level 4

ReasonInfo

links
optional

< Link > array

3.22. Resource«UnitInfo»

Name Schema

assetId
optional

integer (int64)

isSlave
optional

integer (int32)

lineId
optional

integer (int64)

lineName
optional

string

links
optional

< Link > array

name
optional

string

type
optional

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

3.23. 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.24. TimeSelectionResource

Name Description Schema

endTime
optional

End time in ISO-8601 format

string

eventEpochEndTime
optional

The end time in epoch second format

integer (int64)

eventEpochStartTime
optional

The start time in epoch second format

integer (int64)

links
optional

< Link > array

startTime
optional

Start time in ISO-8601 format

string

3.25. TopNReasonInfo

Name Description Schema

level1
optional

Reason Information Level 1

ReasonInfo

level2
optional

Reason Information Level 2

ReasonInfo

level3
optional

Reason Information Level 3

ReasonInfo

level4
optional

Reason Information Level 4

ReasonInfo

3.26. UnitInfo

Name Schema

assetId
optional

integer (int64)

isSlave
optional

integer (int32)

lineId
optional

integer (int64)

lineName
optional

string

name
optional

string

type
optional

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

3.27. 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.28. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.29. WasteEvent

WasteEvent Object

Name Description Schema

actionCommentId
optional

The comment thread Id for action

integer (int64)

actionLevel1Id
optional

The level 1 action taken on regard to this waste event record

integer (int64)

actionLevel2Id
optional

The level 2 action taken on regard to this waste event record

integer (int64)

actionLevel3Id
optional

The level 3 action taken on regard to this waste event record

integer (int64)

actionLevel4Id
optional

The level 4 action taken on regard to this waste event record

integer (int64)

amount
optional

Amount of waste generated during this waste event

number (double)

amountConversionDivisor
optional

Amount conversion factor. For displaying with wasteMeasurement label divide the amount with this value.

number (double)

associatedProductionEventId
optional

The Production Event id this waste event is associated to in case this is an Event based waste

integer (int64)

associatedProductionEventNum
optional

The Production Event Number this waste event is associated to in case this is an Event based waste

string

causeCommentId
optional

The comment thread Id for cause

integer (int64)

confirmed
optional

Based on whether reasons are filled or not depends on display options (can set for reasons only or for reasons and actions)
Example : false

boolean

entryOn
optional

The time when this record was inserted in PA DB

string (date-time)

masterUnitId
optional

The master unit where this waste is produced

integer (int64)

productId
optional

Product which ended up as waste

integer (int64)

reasonLevel1Id
optional

The level 1 reason what caused this waste

integer (int64)

reasonLevel2Id
optional

The level 2 reason what caused this waste

integer (int64)

reasonLevel3Id
optional

The level 3 reason what caused this waste

integer (int64)

reasonLevel4Id
optional

The level 4 reason what caused this waste

integer (int64)

sourceUnitId
optional

The exact unit Id (slave or master) where this waste is produced

integer (int64)

timestamp
optional

The time(ISO 8601) when this waste is generated

string (date-time)

user
optional

User who raised this waste event

string

wasteEventFaultId
optional

Fault associated with this waste event

integer (int64)

wasteEventId
optional

The unique ID for this Waste Event

integer (int64)

wasteEventTypeId
optional

Waste Event Type which this waste event comes under

integer (int64)

wasteMeasurementId
optional

Waste Measurement used to measure the waste amount

integer (int64)

3.30. WasteEventCreatorMachineData

Name Description Schema

actionHeaders
optional

Reason Header Information

CollectionResource«ReasonHeaderInfo»

actionOptions
optional

Reason Information

CollectionResource«ReasonInfo»

earliestPossibleTime
optional

Earliest Possible Time

string (date-time)

faultOptions
optional

Fault Information

< FaultInfo > array

latestPossibleTime
optional

Latest Possible Time

string (date-time)

reasonHeaders
optional

Reason Header Information

CollectionResource«ReasonHeaderInfo»

reasonOptions
optional

Reason Information

CollectionResource«ReasonInfo»

top5Actions
optional

Top 5 Actions Information

< Resource«TopNReasonInfo» > array

top5Reasons
optional

Top 5 Reasons Information

< Resource«TopNReasonInfo» > array

3.31. WasteEventForCreate

Name Schema

actionLevel1Id
optional

integer (int64)

actionLevel2Id
optional

integer (int64)

actionLevel3Id
optional

integer (int64)

actionLevel4Id
optional

integer (int64)

amount
optional

number (double)

associatedProductionEventId
optional

integer (int64)

causeCommentText
optional

string

masterUnitId
optional

integer (int64)

reasonLevel1Id
optional

integer (int64)

reasonLevel2Id
optional

integer (int64)

reasonLevel3Id
optional

integer (int64)

reasonLevel4Id
optional

integer (int64)

sourceUnitId
optional

integer (int64)

timestamp
optional

string (date-time)

wasteEventFaultId
optional

integer (int64)

wasteEventTypeId
optional

integer (int64)

wasteMeasurementId
optional

integer (int64)

3.32. WasteEventForUpdate

Name Schema

actionLevel1Id
optional

integer (int64)

actionLevel2Id
optional

integer (int64)

actionLevel3Id
optional

integer (int64)

actionLevel4Id
optional

integer (int64)

amount
optional

number (double)

associatedProductionEventId
optional

integer (int64)

causeComment
optional

integer (int64)

masterUnitId
optional

integer (int64)

reasonLevel1Id
optional

integer (int64)

reasonLevel2Id
optional

integer (int64)

reasonLevel3Id
optional

integer (int64)

reasonLevel4Id
optional

integer (int64)

sourceUnitId
optional

integer (int64)

timestamp
optional

string (date-time)

wasteEventFaultId
optional

integer (int64)

wasteEventTypeId
optional

integer (int64)

wasteMeasurementId
optional

integer (int64)

3.33. WasteEventResponse

Name Description Schema

actionCommentId
optional

integer (int64)

actionHeaders
optional

Action Header Information

CollectionResource«ReasonHeaderInfo»

actionLevel1Id
optional

integer (int64)

actionLevel1Name
optional

string

actionLevel2Id
optional

integer (int64)

actionLevel2Name
optional

string

actionLevel3Id
optional

integer (int64)

actionLevel3Name
optional

string

actionLevel4Id
optional

integer (int64)

actionLevel4Name
optional

string

actionOptions
optional

Actions Information

CollectionResource«ReasonInfo»

amount
optional

number (double)

amountConversionDivisor
optional

number (double)

asset
optional

Asset Information

AssetInfo

associatedProductionEventId
optional

integer (int64)

associatedProductionEventNum
optional

string

causeCommentId
optional

integer (int64)

confirmed
optional

boolean

department
optional

Department Information

AssetInfo

entryOn
optional

string (date-time)

faultOptions
optional

Fault Information

< FaultInfo > array

line
optional

Line Information

AssetInfo

machineOptions
optional

Machine Information

< AssetInfo > array

masterUnitId
optional

integer (int64)

masterUnitName
optional

string

permissions
optional

Permission Information

< string, boolean > map

productId
optional

integer (int64)

productName
optional

string

reasonHeaders
optional

Reason Header Information

CollectionResource«ReasonHeaderInfo»

reasonLevel1Id
optional

integer (int64)

reasonLevel1Name
optional

string

reasonLevel2Id
optional

integer (int64)

reasonLevel2Name
optional

string

reasonLevel3Id
optional

integer (int64)

reasonLevel3Name
optional

string

reasonLevel4Id
optional

integer (int64)

reasonLevel4Name
optional

string

reasonOptions
optional

Reason Information

CollectionResource«ReasonInfo»

sourceUnitId
optional

integer (int64)

sourceUnitName
optional

string

timestamp
optional

string (date-time)

top5Actions
optional

Top 5 Actions Information

< Resource«TopNReasonInfo» > array

top5Reasons
optional

Top N Reason Information

< Resource«TopNReasonInfo» > array

user
optional

string

wasteEventFaultId
optional

integer (int64)

wasteEventFaultName
optional

string

wasteEventId
optional

integer (int64)

wasteEventTypeId
optional

integer (int64)

wasteEventTypeName
optional

string

wasteMeasurement
optional

< WasteMeasurementRecord > array

wasteMeasurementId
optional

integer (int64)

wasteMeasurementName
optional

string

3.34. WasteEventTypeRecord

Name Schema

readOnly
optional

boolean

wasteEventTypeId
optional

integer (int64)

wasteEventTypeName
optional

string

3.35. WasteMeasurementRecord

Name Description Schema

conversionFactor
optional

Constant used to convert waste amount

number (double)

conversionSpecVariableId
optional

Variable Id whose targetSpec(based on the product) would be used as conversion factor in case specified

integer (int64)

id
optional

The unique ID for this Waste Measurement

integer (int64)

masterUnitId
optional

Unit to which this measurement record belongs

integer (int64)

name
optional

Label of this Measurement

string

4. Security

4.1. oauth

Type : oauth2
Flow : accessCode
Token URL : https://Alpha2-pa/uaa/oauth/authorize
Token URL : https://Alpha2-pa/uaa/oauth/token

Name Description

default

Default oauth2 scope.