1. Overview

The service contains a collection of RESTful service calls relating to Alarms 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

  • alarm-controller : Alarm Controller

  • alarm-editor-controller : Alarm Editor Controller

  • comment-controller : Comment Controller

  • user-settings-controller : User Settings Controller

  • variable-controller : Variable Controller

2. Resources

2.1. Alarm-controller

Alarm Controller

2.1.1. Get all Alarms based on the request parameters

GET /alarmsViewer
Parameters
Type Name Description Schema Default

Query

endTime
optional

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

string (date-time)

Query

sortColumn
optional

Property name on which sorting is to be done, supports sorting on only single property

string

"startTime"

Query

sortDirection
optional

Sort Direction, either asc or desc

string

"desc"

Query

startTime
optional

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

string (date-time)

Query

timeSelection
required

Time selection value
1 - Current Day
2 - Prev Day
3 - Current Week
4 - Prev Week
5 - Next Week
6 - Next Day
8 - Current Shift
9 - Previous Shift
10- Next Shift

integer (int32)

8
Responses
HTTP Code Description Schema

200

OK

< AlarmRecordsListResource > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.1.2. Gets the alarm record for the alarm Id provided.

GET /alarmsViewer/{alarmId}
Parameters
Type Name Description Schema

Path

alarmId
required

Alarm Id to retireve the Alarm Record

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AlarmRecordsListResource

404

Not Found, No Alarm found for this alarm Id

HttpErrorResponse

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2. Alarm-editor-controller

Alarm Editor Controller

2.2.1. Get the Alarm Edit State details

GET /alarmEditor
Parameters
Type Name Description Schema Default

Query

alarmId
required

Id of the Alarm for which Edit state is requested

integer (int64)

Query

expandActions
optional

Flag indicating whether the Action Options should be retrieved

boolean

"false"

Query

expandCause
optional

Flag indicating whether the Cause Options should be retrieved

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

AlarmEditorStateResource

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

No Content

500

Internal Server error, See logs for details

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.2. Get the alarm Reason Trees

GET /alarmEditor/reasonTree
Parameters
Type Name Description Schema

Query

alarmId
required

Id of the Alarm for which Reason Trees are requested

integer (int64)

Query

reasonTreeType
required

Parameter specifying the type of Reason Tree.

enum (CauseTree, ActionTree)
Responses
HTTP Code Description Schema

200

OK

< ReasonTreeNodeDto > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.3. Fetches top reasons for the alarm

GET /alarmEditor/topReasons
Parameters
Type Name Description Schema Default

Query

alarmId
required

The alarmId for which top reasons are required

integer (int64)

Query

reasonType
required

Reason tree type to get the specified type of top reasons

enum (Action, Cause)

Query

topReasonsCount
optional

Required number of top reasons

integer (int64)

5
Responses
HTTP Code Description Schema

200

OK

TopNReasonsDtoResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

oauth

default

2.2.4. Updates the alarm record for the alarm Id provided.

PUT /alarmEditor/{alarmId}
Parameters
Type Name Description Schema

Path

alarmId
required

Alarm Id of the Alarm Record to update

integer (int64)

Body

alarmRecordUpdateData
required

Alarm Record details to be updated, All the values in this will be updated in DB

AlarmRecordUpdateData
Responses
HTTP Code Description Schema

200

OK

AlarmRecordResource

304

Not Modified, Request body values same as Data Base

HttpErrorResponse

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden, Authenticated user not present in PlantApps

HttpErrorResponse

404

Not Found, No Alarm found for this alarm Id

HttpErrorResponse

422

Unprocessable Entity, Invalid data in the request body

HttpErrorResponse

500

Internal Server error, See logs for details

No Content
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2.5. Acknowledges the alarm record of the alarm Id provided.

PUT /alarmEditor/{alarmId}/acknowledge
Parameters
Type Name Description Schema

Path

alarmId
required

Alarm Id of the Alarm Record to acknowledge

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AlarmRecordResource

304

Not Modified, Request body values same as Data Base

HttpErrorResponse

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden, Authenticated user not present in PlantApps

HttpErrorResponse

404

Not Found, No Alarm found for this alarm Id

HttpErrorResponse

422

Unprocessable Entity, Invalid data in the request body

HttpErrorResponse

500

Internal Server error, See logs for details

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3. Comment-controller

Comment Controller

2.3.1. Adds an alarm Comment

POST /alarmComments
Parameters
Type Name Description Schema

Query

alarmId
required

Id of the Alarm to which comment needs to be added.

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (CauseComment, ActionComment)

Body

comment
optional

Comment text to be added.

Comment
Responses
HTTP Code Description Schema

201

Created, Comment SuccessFully created.

CommentInfo

400

Bad Request, Unable to add the comment, Please check the validity of request object.

HttpErrorResponse

403

Forbidden, User not allowed to add comments.

HttpErrorResponse

422

Unprocessable Entity, Missing Required field in comment.

HttpErrorResponse

500

Internal Server Error, Please contact admin.

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.3.2. Get all the Alarm Comments

GET /alarmComments
Parameters
Type Name Description Schema

Query

alarmId
required

Id of the alarm for which the comment history is required.

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (CauseComment, ActionComment)
Responses
HTTP Code Description Schema

200

Ok, Comments fetched successfully.

< CommentInfo > array

400

Bad Request, Invalid Comment Type or Non existant alarmId

HttpErrorResponse

401

Unauthorized, Unauthorized user.

No Content

403

Forbidden, User not allowed to get the comment records.

HttpErrorResponse

500

Internal Server Error

No Content

503

Service Unavailable.

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3.3. Updates an alarm Comment

PUT /alarmComments
Parameters
Type Name Description Schema

Query

alarmId
required

Id of the Alarm to which comment needs to be updated.

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (CauseComment, ActionComment)

Body

comment
required

comment details to be updated

Comment
Responses
HTTP Code Description Schema

200

Ok, Comment SuccessFully updated.

CommentInfo

400

Bad Request, Unable to update the comment, Please check the validity of request object.

HttpErrorResponse

403

Forbidden, User not allowed to update the comment.

HttpErrorResponse

422

Unprocessable Entity, Missing Required field in comment.

HttpErrorResponse

500

Internal Server Error, Please contact admin.

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.3.4. Deletes an alarm Comment

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

Path

commentId
required

Id of the comment which needs to be deleted.

integer (int64)

Query

alarmId
required

Id of the Alarm from which the comment needs to be deleted.

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (CauseComment, ActionComment)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content, Comment deleted successfully.

No Content

400

Bad Request, Invalid Comment Type or Non existant alarmId.

HttpErrorResponse

403

Forbidden, User not allowed to delete the comment.

HttpErrorResponse

404

Not Found, No Comment Found with given commentId.

HttpErrorResponse

500

Internal Server Error, Please contact admin.

No Content

503

Service Unavailable.

No Content
Produces

  • application/json;charset=UTF-8

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

Variable Controller

2.5.1. Gets the alarm Variable Info and the trend for the provided alarm Id.

GET /variableTrend
Parameters
Type Name Description Schema

Query

alarmId
required

Alarm Id to retireve the Alarm Variable Trend details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

VariableInfoesponse

400

Bad Request

HttpErrorResponse

403

Forbidden

HttpErrorResponse

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5.2. Gets the alarm variable ids the user has access to and which belongs to the preferred Machines, User wil only see alarms and notifications for there variables

GET /variablesForWebsocketSubscription
Responses
HTTP Code Description Schema

200

OK

< integer (int64) > array

400

Bad Request

HttpErrorResponse

403

Forbidden

HttpErrorResponse

500

Internal Server Error

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

3. Definitions

3.1. AlarmEditorStateResource

Name Description Schema

actionHeaders
optional

Action Header Information

< ReasonTreeHeaderDto > array

actionOptions
optional

Action reasons available for the Alarm.

CollectionResource«ReasonTreeNodeDto»

alarmHeaderInfo
optional

Alarm information

AlarmRecord

causeOptions
optional

Cause reasons available for the Alarm.

CollectionResource«ReasonTreeNodeDto»

links
optional

< Link > array

reasonHeaders
optional

Reason Header Information

< ReasonTreeHeaderDto > array

3.2. AlarmRecord

Alarm Record Object

Name Description Schema

acknowledged
optional

Whether this alarm is acknowledged or not
Example : false

boolean

acknowledgedBy
optional

Name of the user who acknowledged this alarm

string

acknowledgedOn
optional

Time when this alarm was acknowledged on(ISO 8601)

string (date-time)

action1
optional

The level 1 action taken for on regard to this alarm

IdNameValue

action2
optional

The level 2 action taken for on regard to this alarm

IdNameValue

action3
optional

The level 3 action taken for on regard to this alarm

IdNameValue

action4
optional

The level 4 action taken for on regard to this alarm

IdNameValue

actionCommentId
optional

The comment thread Id for action

integer (int64)

actionRequired
optional

Whether this alarm record requires actions to be selected
Example : false

boolean

actionTreeId
optional

The reason tree Id which is configured as action tree for this alarms template

integer (int64)

alarmDescription
optional

The description for this alarm

string

alarmId
optional

The unique ID for this Alarm Record

integer (int64)

alarmRule
optional

The title of the Alarm Template this alarm is based on

string

alarmType
optional

The Alarm Type

IdNameValue

canAcknowledge
optional

Whether this alarm record can be acknoledged
Example : false

boolean

canPerform
optional

Whether this alarm record can be editied to add cause and actions
Example : false

boolean

cause1
optional

The level 1 cause why this alarm has been raised

IdNameValue

cause2
optional

The level 2 cause why this alarm has been raised

IdNameValue

cause3
optional

The level 3 cause why this alarm has been raised

IdNameValue

cause4
optional

The level 4 cause why this alarm has been raised

IdNameValue

causeCommentId
optional

The comment thread Id for cause

integer (int64)

causeRequired
optional

Whether this alarm record requires causes to be selected
Example : false

boolean

causeTreeId
optional

The reason tree Id which is configured as cause tree for this alarms template

integer (int64)

duration
optional

The duration (in seconds) this alarm spans from starting to end

integer (int64)

endTime
optional

The end time(ISO 8601) of this alarm

string (date-time)

endValue
optional

Value of the variable’s test when the Alarm is closed

object

eventCount
optional

Number of event this alarm spans after alarm is triggered and until its ends

integer (int64)

eventSubTypeDescription
optional

The event SubType Description, eg Batch

string

links
optional

< Link > array

priority
optional

The severity of this alarm

IdNameValue

sourceUnit
optional

The unit where the alarm is raised

IdNameValue

sourceVariable
optional

The variable for which the alarm got raised

IdNameValue

sourceVariableDataType
optional

Data type of the alarm source veriable (ex. Integer, String..)

IdNameValue

startTime
optional

The start time(ISO 8601) of this alarm

string (date-time)

startValue
optional

Value of the variable’s test when the Alarm is opened

object

3.3. AlarmRecordResource

Name Description Schema

acknowledged
optional

Whether this alarm is acknowledged or not
Example : false

boolean

acknowledgedBy
optional

Name of the user who acknowledged this alarm

string

acknowledgedOn
optional

Time when this alarm was acknowledged on(ISO 8601)

string (date-time)

action1
optional

The level 1 action taken for on regard to this alarm

IdNameValue

action2
optional

The level 2 action taken for on regard to this alarm

IdNameValue

action3
optional

The level 3 action taken for on regard to this alarm

IdNameValue

action4
optional

The level 4 action taken for on regard to this alarm

IdNameValue

actionCommentId
optional

The comment thread Id for action

integer (int64)

actionRequired
optional

Whether this alarm record requires actions to be selected
Example : false

boolean

actionTreeId
optional

The reason tree Id which is configured as action tree for this alarms template

integer (int64)

alarmDescription
optional

The description for this alarm

string

alarmId
optional

The unique ID for this Alarm Record

integer (int64)

alarmRule
optional

The title of the Alarm Template this alarm is based on

string

alarmType
optional

The Alarm Type

IdNameValue

canAcknowledge
optional

Whether this alarm record can be acknoledged
Example : false

boolean

canPerform
optional

Whether this alarm record can be editied to add cause and actions
Example : false

boolean

cause1
optional

The level 1 cause why this alarm has been raised

IdNameValue

cause2
optional

The level 2 cause why this alarm has been raised

IdNameValue

cause3
optional

The level 3 cause why this alarm has been raised

IdNameValue

cause4
optional

The level 4 cause why this alarm has been raised

IdNameValue

causeCommentId
optional

The comment thread Id for cause

integer (int64)

causeRequired
optional

Whether this alarm record requires causes to be selected
Example : false

boolean

causeTreeId
optional

The reason tree Id which is configured as cause tree for this alarms template

integer (int64)

duration
optional

The duration (in seconds) this alarm spans from starting to end

integer (int64)

endTime
optional

The end time(ISO 8601) of this alarm

string (date-time)

endValue
optional

Value of the variable’s test when the Alarm is closed

object

eventCount
optional

Number of event this alarm spans after alarm is triggered and until its ends

integer (int64)

eventSubTypeDescription
optional

The event SubType Description, eg Batch

string

links
optional

< Link > array

priority
optional

The severity of this alarm

IdNameValue

sourceUnit
optional

The unit where the alarm is raised

IdNameValue

sourceVariable
optional

The variable for which the alarm got raised

IdNameValue

sourceVariableDataType
optional

Data type of the alarm source veriable (ex. Integer, String..)

IdNameValue

startTime
optional

The start time(ISO 8601) of this alarm

string (date-time)

startValue
optional

Value of the variable’s test when the Alarm is opened

object

3.4. AlarmRecordUpdateData

Object to hold data for updating the alarm record

Name Description Schema

acknowledge
optional

Whether this alarm is acknowledged or not
Example : false

boolean

action1
optional

The level 1 action taken for on regard to this alarm

integer (int64)

action2
optional

The level 2 action taken for on regard to this alarm

integer (int64)

action3
optional

The level 3 action taken for on regard to this alarm

integer (int64)

action4
optional

The level 4 action taken for on regard to this alarm

integer (int64)

cause1
optional

The level 1 cause why this alarm has been raised

integer (int64)

cause2
optional

The level 2 cause why this alarm has been raised

integer (int64)

cause3
optional

The level 3 cause why this alarm has been raised

integer (int64)

cause4
optional

The level 4 cause why this alarm has been raised

integer (int64)

3.5. AlarmRecordsListResource

Name Description Schema

acknowledged
optional

Whether this alarm is acknowledged or not
Example : false

boolean

acknowledgedBy
optional

Name of the user who acknowledged this alarm

string

acknowledgedOn
optional

Time when this alarm was acknowledged on(ISO 8601)

string (date-time)

action1
optional

The level 1 action taken for on regard to this alarm

IdNameValue

action2
optional

The level 2 action taken for on regard to this alarm

IdNameValue

action3
optional

The level 3 action taken for on regard to this alarm

IdNameValue

action4
optional

The level 4 action taken for on regard to this alarm

IdNameValue

actionCommentId
optional

The comment thread Id for action

integer (int64)

actionRequired
optional

Whether this alarm record requires actions to be selected
Example : false

boolean

actionTreeId
optional

The reason tree Id which is configured as action tree for this alarms template

integer (int64)

alarmDescription
optional

The description for this alarm

string

alarmId
optional

The unique ID for this Alarm Record

integer (int64)

alarmRule
optional

The title of the Alarm Template this alarm is based on

string

alarmType
optional

The Alarm Type

IdNameValue

canAcknowledge
optional

Whether this alarm record can be acknoledged
Example : false

boolean

canPerform
optional

Whether this alarm record can be editied to add cause and actions
Example : false

boolean

cause1
optional

The level 1 cause why this alarm has been raised

IdNameValue

cause2
optional

The level 2 cause why this alarm has been raised

IdNameValue

cause3
optional

The level 3 cause why this alarm has been raised

IdNameValue

cause4
optional

The level 4 cause why this alarm has been raised

IdNameValue

causeCommentId
optional

The comment thread Id for cause

integer (int64)

causeRequired
optional

Whether this alarm record requires causes to be selected
Example : false

boolean

causeTreeId
optional

The reason tree Id which is configured as cause tree for this alarms template

integer (int64)

duration
optional

The duration (in seconds) this alarm spans from starting to end

integer (int64)

endTime
optional

The end time(ISO 8601) of this alarm

string (date-time)

endValue
optional

Value of the variable’s test when the Alarm is closed

object

eventCount
optional

Number of event this alarm spans after alarm is triggered and until its ends

integer (int64)

eventSubTypeDescription
optional

The event SubType Description, eg Batch

string

links
optional

< Link > array

priority
optional

The severity of this alarm

IdNameValue

sourceUnit
optional

The unit where the alarm is raised

IdNameValue

sourceVariable
optional

The variable for which the alarm got raised

IdNameValue

sourceVariableDataType
optional

Data type of the alarm source veriable (ex. Integer, String..)

IdNameValue

startTime
optional

The start time(ISO 8601) of this alarm

string (date-time)

startValue
optional

Value of the variable’s test when the Alarm is opened

object

3.6. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.7. CollectionResource«ReasonTreeNodeDto»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonTreeNodeDto > array

links
optional

< Link > array

3.8. Comment

Name Description Schema

commentId
optional

The Id of the comment. Required field while updating the comment

integer (int64)

commentText
optional

comment text

string

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

commentType
optional

Type of comment, Alarm Action or Alarm Cause Comments

enum (ActionComment, CauseComment)

threadId
optional

Id of the Thread the comment belongs to.

integer (int64)

user
optional

comment owner

IdNameValue

3.10. DataValue

Name Schema

quality
optional

boolean

timeStamp
optional

string (date-time)

value
optional

string

3.11. Error

Name Schema

code
optional

string

details
optional

object

3.12. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.13. IdNameValue

Generic object to hold Id value pair

Name Description Schema

id
optional

ID for thos pair

integer (int64)

name
optional

Name of this pair

string

3.14. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.15. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.16. ReasonDto

Name Description Schema

reasonId
optional

The unique identifier of the reason

integer (int64)

reasonName
optional

The name of the reason

string

3.17. ReasonTreeHeaderDto

Name Description Schema

levelName
optional

Name of the level can be 1-level1 2-level2 3-level3 4-level4 of a reason

string

reasonLevel
optional

The level can be 1-level1 2-level2 3-level3 4-level4 of the reason

integer (int32)

3.18. ReasonTreeNodeDto

Name Description Schema

categoryId
optional

The categoryId of the reason

integer (int64)

categoryName
optional

The category name of reason

string

children
optional

The List of the reasonTreeNode

< ReasonTreeNodeDto > array

links
optional

< Link > array

nodeId
optional

The Unique identifier of node

integer (int64)

parentNodeId
optional

The Unique identifier of parentNode

integer (int64)

reasonId
optional

The Unique identifier of reason

integer (int64)

reasonLevel
optional

The level can be 1-level1 2-level2 3-level3 4-level4 of reason

integer (int32)

reasonName
optional

The name of the reason

string

treeId
optional

The Unique identifier of tree

integer (int64)

3.19. TopNReasonsDto

Name Description Schema

level1
optional

The level1 of reason

ReasonDto

level2
optional

The level2 of reason

ReasonDto

level3
optional

The level3 of reason

ReasonDto

level4
optional

The level4 of reason

ReasonDto

3.20. TopNReasonsDtoResponse

Name Schema

content
optional

< TopNReasonsDto > array

links
optional

< Link > array

3.21. 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.22. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.23. VariableInfoesponse

Name Description Schema

links
optional

< Link > array

variableDataType
optional

Data type of the veriable (ex. Integer, String..)

IdNameValue

variableEngUnit
optional

The engineerng unit of the variable (ex. Kg, Lux..)

string

variableHistory
optional

List of test values of the variable between the variableHistoryStartTime and variableHistoryEndTime

< DataValue > array

variableHistoryEndTime
optional

Variable History End Time calculated based on the Site parameter and alarm end time or alarm start time

string (date-time)

variableHistoryStartTime
optional

Variable History Start Time calculated based on the Site parameter and alarm start time

string (date-time)

variableId
optional

The source variable ID of Alarm Record

integer (int64)

variableName
optional

The Name of the variable on which the alarm is raised

string

variableSpecificationLimit
optional

List of the variable specification between the variableHistoryStartTime and variableHistoryEndTime irrespective of the product

< VariableSpecificationLimit > array

variableTrigger
optional

The Id value pair of the trigger of this variable that raised alarm

IdNameValue

3.24. VariableSpecificationLimit

Name Schema

lowerEntry
optional

string

lowerReject
optional

string

lowerUser
optional

string

lowerWarning
optional

string

product
optional

integer (int64)

productDescription
optional

string

startTime
optional

string (date-time)

target
optional

string

upperEntry
optional

string

upperReject
optional

string

upperUser
optional

string

upperWarning
optional

string

variable
optional

integer (int64)

4. Security

4.1. oauth

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.