1. Overview

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

  • color-scheme-field-controller : Color Scheme Field Controller

  • comment-controller : Comment Controller

  • downtime-controller : Downtime Controller

  • downtime-details-controller : Downtime Details Controller

  • downtime-merger-controller : Downtime Merger Controller

  • downtime-mes-controller : Downtime Mes Controller

  • downtime-splitter-controller : Downtime Splitter Controller

  • monitoring-controller : Monitoring Controller

  • my-machines-preferences-controller : My Machines Preferences Controller

  • npt-downtime-controller : Npt Downtime Controller

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Color-scheme-field-controller

Color Scheme Field Controller

2.1.1. Get downtime field colors

GET /downtimeColorSchemeFields
Parameters
Type Name Description Schema Default

Query

colorSchemeId
optional

Color Scheme Id to retrieve the Color Scheme Fields.

integer (int64)

1
Responses
HTTP Code Description Schema

200

OK

ColorSchemeFieldInfoResources
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.2. Comment-controller

Comment Controller

2.2.1. Add a comment

POST /comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (DowntimeCause, DowntimeAction, NonProductiveDetail)

Query

rootId
required

id of the entity to which comments are to be added, it can be downtimeId or nptId.

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.2.2. Get the history of comments for the given root id

GET /comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (DowntimeCause, DowntimeAction, NonProductiveDetail)

Query

rootId
required

id of the entity for which comments are required, it can be downtimeId or nptId.

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.2.3. Update a comment

PUT /comments
Parameters
Type Name Description Schema

Query

commentType
required

Parameter specifying the type of comment.

enum (DowntimeCause, DowntimeAction, NonProductiveDetail)

Query

rootId
required

id of the entity of which comment is to be updated, it can be downtimeId or nptId.

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.2.4. Get the details of a comment

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

Path

commentId
required

commentId

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (DowntimeCause, DowntimeAction, NonProductiveDetail)

Query

rootId
required

id of the entity for which comment is required, it can be downtimeId or nptId.

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.2.5. Delete the downtime comment

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

Path

commentId
required

commentId

integer (int64)

Query

commentType
required

Parameter specifying the type of comment.

enum (DowntimeCause, DowntimeAction, NonProductiveDetail)

Query

rootId
required

id of the entity Of whose comment is to be deleted, it can be downtimeId or nptId.

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.3. Downtime-controller

Downtime Controller

2.3.1. Fetches all downtime records based on the given filter criteria

GET /downtime-viewer
Parameters
Type Name Description Schema Default

Query

endTime
optional

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

string (date-time)

Query

filterCategoryIds
optional

Comma seperated list of category ids

string

Query

filterLocationIds
optional

Comma seperated list of location ids

string

Query

filterMaxDuration
optional

Maximum duration of downtime

number (double)

Query

filterMinDuration
optional

Minimum duration of downtime

number (double)

Query

filterNptOnly
optional

Flag to filter Non Productive Time records

boolean

"false"

Query

filterStatusIds
optional

Comma seperated list of status ids.Status Id values
1 - Open (Downtime with end time set to null)
2 - Active (Downtime closed with reasons incomplete)
3 - Completed (Downtime closed with reasons complete)

string

Query

page
optional

Results page number to retrieve

integer (int32)

Query

size
optional

Number of records per page, from 1 to 500

integer (int32)

Query

sort
optional

Sorting criteria in the format: property(SortColumn,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.Default value is EventId,DESC.
Available columns for sorting:
EventId,StartTime,EndTime,Location,Category,Duration,Uptime,Fault,Status,Reason1,Action1

string

"EventId,DESC"

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
optional

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

integer (int64)

Query

unitIds
optional

Comma separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

DowntimeViewerInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3.2. Copying reasons for downtime records

PUT /downtime-viewer/copy-reasons
Parameters
Type Name Description Schema

Body

downtimeCopyReasonInfo
optional

cause reasons to be copied

DowntimeCopyReasonInfo
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3.3. Get a downtime record

GET /downtime-viewer/downtimeRecord/{id}
Parameters
Type Name Description Schema

Path

id
optional

Downtime Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Downtime

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.3.4. Fetches a page of downtime records based on the given filter criteria

GET /downtime-viewer/downtimes
Parameters
Type Name Description Schema Default

Query

endTime
optional

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

string (date-time)

Query

filterCategoryIds
optional

Comma seperated list of category ids

string

Query

filterLocationIds
optional

Comma seperated list of location ids

string

Query

filterMaxDuration
optional

Maximum duration of downtime

number (double)

Query

filterMinDuration
optional

Minimum duration of downtime

number (double)

Query

filterNptOnly
optional

Flag to filter Non Productive Time records

boolean

Query

filterStatusIds
optional

Comma seperated list of status ids.Status Id values
1 - Open (Downtime with end time set to null)
2 - Active (Downtime closed with reasons incomplete)
3 - Completed (Downtime closed with reasons complete)

string

Query

page
optional

Results page number to retrieve

integer (int32)

Query

size
optional

Number of records per page, from 1 to 500

integer (int32)

Query

sort
optional

Sorting criteria in the format: property(SortColumn,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.Default value is EventId,DESC.
Available columns for sorting:
EventId,StartTime,EndTime,Location,Category,Duration,Uptime,Fault,Status,Reason1,Action1

string

"EventId,DESC"

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
optional

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

integer (int64)

Query

unitIds
required

Comma separated list of unit ids

string
Responses
HTTP Code Description Schema

200

OK

DowntimeViewerInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4. Downtime-details-controller

Downtime Details Controller

2.4.1. Fetches downtime information for the given downtime id

GET /downtime-editor
Parameters
Type Name Description Schema Default

Query

downtimeId
required

Downtime Id for which information needs to be fetched

integer (int64)

Query

expandFaults
optional

Flag specifying whether the Fault Options should be retrieved and populated

boolean

"true"

Query

expandMachines
optional

Flag indicating whether the Machines Options should be retrieved and populated

boolean

"true"

Query

expandReasons
optional

Flag indicating whether the Reasons Options should be retrieved and populated

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.2. Updates an existing downtime record with the given downtime id

PUT /downtime-editor
Parameters
Type Name Description Schema

Query

downtimeId
required

Id of the downtime record to be updated

integer (int64)

Body

downtimeRecordUpdates
optional

Content of the downtime record to be updated

DowntimeRecordUpdates
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.3. Deletes a record with the given downtime id

DELETE /downtime-editor
Parameters
Type Name Description Schema

Query

downtimeId
required

Id of the downtime record to be deleted

integer (int64)
Responses
HTTP Code Description Schema

200

OK

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

oauth

default

2.4.4. Fetches actions tree header information for the given unit id

GET /downtime-editor/actionheaders
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which actions and headers information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonHeaderInfo

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.4.5. Fetches actions information for the given unit id

GET /downtime-editor/actions
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which actions information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonInfo

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.4.6. Fetches faults information for the given unit id

GET /downtime-editor/faults
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which faults information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

FaultInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.7. Fetches the slave machine information for the given unit id

GET /downtime-editor/machines
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which machines information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssetInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.8. Merges an existing downtime record with the record of the given downtime id

PUT /downtime-editor/merge
Parameters
Type Name Description Schema

Query

downtimeId
required

Id of the downtime record to be merged

integer (int64)

Body

downtimeRecordUpdates
optional

Content of the downtime record to be merged

DowntimeRecordUpdates
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.9. Fetches reasons information for the given unit id

GET /downtime-editor/reasons
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which reasons information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonInfo

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.4.10. Fetches reasons tree header information for the given unit id

GET /downtime-editor/reasonsheaders
Parameters
Type Name Description Schema

Query

unitId
required

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

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonHeaderInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.4.11. Fetches top 5(max 5 or less) actions information for the given unit id

GET /downtime-editor/topNactions
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which the top 5(max 5 or less) actions information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

TopNReasonInfo

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.4.12. Fetches top 5(max 5 or less) information for the given unit id

GET /downtime-editor/topNreasons
Parameters
Type Name Description Schema

Query

unitId
required

Unit id for which the top 5(max 5 or less) reasons information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

TopNReasonInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.5. Downtime-merger-controller

Downtime Merger Controller

2.5.1. Fetches information on the total number of events to be merged, the time duration between the given earliest downtime id and the latest downtime id

GET /downtime-merger
Parameters
Type Name Description Schema Default

Query

earliestDowntimeId
required

The earliest downtime record id

integer (int64)

Query

latestDowntimeId
required

The latest downtime record 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)

Query

sort
optional

Sorting criteria in the format: property(SortColumn,asc|desc). Default sort order is ascending. Multiple sort criteria is not supported.Default value is EventId,DESC.
Available columns for sorting:
EventId,StartTime,EndTime,Location,Category,Duration,Uptime,Fault,Status,Reason1,Action1

string

"EventId,DESC"
Responses
HTTP Code Description Schema

200

OK

DowntimeMergerSummary

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.5.2. Merges the given input downtime object content with the target parent downtime id

PUT /downtime-merger
Parameters
Type Name Description Schema

Query

downtimeId
required

The id specifying the downtime record to be merged

integer (int64)

Body

downtimeRecordUpdates
optional

Content of the downtime record to be merged

DowntimeRecordUpdates
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6. Downtime-mes-controller

Downtime Mes Controller

2.6.1. Creates a new downtime record

POST /downtime-creator
Parameters
Type Name Description Schema

Body

downtimeRecordUpdates
required

Content of the downtime record to be created

DowntimeRecordUpdates
Responses
HTTP Code Description Schema

200

OK

DowntimeRecordUpdates

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.6.2. Fetches departments,lines and units information

GET /downtime-creator
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

DowntimeCreatorInfo

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. Fetches lines information for the given department id

GET /downtime-creator/departments/{deptId}/lines
Parameters
Type Name Description Schema

Path

deptId
required

department id for which lines information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssetInfo

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.4. Fetches units information for the given line id

GET /downtime-creator/lines/{lineId}/units
Parameters
Type Name Description Schema

Path

lineId
required

line id for which units information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssetInfo

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. Fetches reasons and fault information for the given unit Id

GET /downtime-creator/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

DowntimeCreatorMachineData

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.7. Downtime-splitter-controller

Downtime Splitter Controller

2.7.1. Fetches downtime information with the given id for splitting

GET /downtime-splitter
Parameters
Type Name Description Schema Default

Query

downtimeId
required

downtime id for which the edit state information needs to be fetched for splitting

integer (int64)

Query

expandReasons
optional

Flag to indicate whether the reasons information should be retrieved and populated

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

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.7.2. Splits Downtime Record

PATCH /downtime-splitter
Parameters
Type Name Description Schema

Body

downtimeRecordUpdates
required

The updates to make to the downtime record

< DowntimeRecordUpdates > array
Responses
HTTP Code Description Schema

200

OK

DowntimeEditorOverviewInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.8. Monitoring-controller

Monitoring Controller

2.8.1. Get 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»
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.8.2. Get 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»
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.9. My-machines-preferences-controller

My Machines Preferences Controller

2.9.1. Fetches unit preferences for the given downtime state

GET /my-machines/unit-preferences
Responses
HTTP Code Description Schema

200

OK

UnitInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10. Npt-downtime-controller

Npt Downtime Controller

2.10.1. Add a Non Productive Time record

POST /npt-creator
Parameters
Type Name Description Schema

Body

nptRecordInfo
required

The updates to make to the non-productive record

NptCreateInfo
Responses
HTTP Code Description Schema

200

OK

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.2. Fetches departments, lines and units information

GET /npt-creator
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

DowntimeCreatorInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.3. Fetches lines information for the given department id

GET /npt-creator/departments/{deptId}/lines
Parameters
Type Name Description Schema

Path

deptId
required

department id for which lines information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssetInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.4. Fetches units information for the given line id

GET /npt-creator/lines/{lineId}/units
Parameters
Type Name Description Schema

Path

lineId
required

line id for which units information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssetInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.5. Fetches Non Productive Time related headers information for the given unit id

GET /npt-creator/nptheaders
Parameters
Type Name Description Schema

Query

unitId
required

unit id for which reasons and header information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonHeaderInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.6. Fetches Non Productive Time related reasons information for the given unit id

GET /npt-creator/nptreasons
Parameters
Type Name Description Schema

Query

unitId
required

unit id for which the non-productive downtime reasons information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ReasonHeaderInfo

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.7. Fetches the Non Productive Time related slave machine information for the given unit id

GET /npt-creator/units/{unitId}/machineData
Parameters
Type Name Description Schema Default

Path

unitId
required

unit id for which reasons and headers information needs to be fetched

integer (int64)

Query

expandReasons
optional

Flag to indicate whether the reasons information should be retrieved and populated

boolean

"true"
Responses
HTTP Code Description Schema

200

OK

NptCreatorMachineData

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.10.8. Fetches Npt record

GET /npt-creator/{nptId}
Parameters
Type Name Description Schema

Path

nptId
required

nptId

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

NptRecord

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by Downtime Application

No Content

404

Not Found

No Content
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

oauth

default

2.11. User-settings-controller

User Settings Controller

2.11.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.11.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.11.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.11.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.11.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

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

Name Description Schema

assetId
optional

The asset ID

integer (int64)

name
optional

The name of the asset

string

type
optional

The type of the asset

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

3.3. CategoryInfo

Name Description Schema

categoryId
optional

Id of the Category

integer (int64)

name
optional

Name of the Category

string

3.4. CategorySummary

Name Description Schema

categoryIds
optional

List of the Category Ids having the Category Name

< integer (int64) > array

count
optional

Count of the Category in the Page

integer (int64)

name
optional

Name of the Category

string

3.5. CollectionMetadata

Name Schema

totalElements
optional

integer (int32)

3.6. CollectionResource«AssetInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< AssetInfo > array

links
optional

< Link > array

3.7. CollectionResource«FaultInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< FaultInfo > array

links
optional

< Link > array

3.8. CollectionResource«ReasonHeaderInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonHeaderInfo > array

links
optional

< Link > array

3.9. CollectionResource«ReasonInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< ReasonInfo > array

links
optional

< Link > array

3.10. CollectionResource«Resource«LineInfo»»

Name Schema

collection
optional

CollectionMetadata

content
optional

< Resource«LineInfo» > array

links
optional

< Link > array

3.11. CollectionResource«Resource«UnitInfo»»

Name Schema

collection
optional

CollectionMetadata

content
optional

< Resource«UnitInfo» > array

links
optional

< Link > array

3.12. CollectionResource«TopNReasonInfo»

Name Schema

collection
optional

CollectionMetadata

content
optional

< TopNReasonInfo > array

links
optional

< Link > array

3.13. ColorSchemeFieldInfo

Name Description Schema

category
optional

Category of the Color Scheme Field.

enum (AutologCellForeground, AutologCellBackground, Spreadsheet, Trendsheet, DelayReports, QualityReports, COAReports, OtherReports, ProficyWebCharts, Downtime, Waste)

color
optional

Color Code.

string

colorSchemeFieldDesc
optional

string

colorSchemeFieldId
optional

integer (int64)

colorSchemeInfo
optional

Color Scheme to which Color Scheme Field belongs to.

ColorSchemeInfo

3.14. ColorSchemeFieldInfoResources

Name Schema

content
optional

< ColorSchemeFieldInfo > array

links
optional

< Link > array

3.15. ColorSchemeInfo

Name Schema

colorSchemeDesc
optional

string

colorSchemeId
optional

integer (int64)

3.16. CommentInfo

Name Description Schema

commentId
optional

Id for Comment

integer (int64)

commentText
optional

Comment Content

string

commentTime
optional

Time of the Comment

string (date-time)

threadId
optional

Id for Thread

integer (int64)

user
optional

User Details

IdNameValue

3.17. DepartmentInfo

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

lines
optional

Lines under a department

CollectionResource«Resource«LineInfo»»

name
optional

Name of the asset

string

3.18. Downtime

Name Description Schema

action1
optional

Downtime Action1 Information

ReasonInfo

action2
optional

Downtime Action2 Information

ReasonInfo

action3
optional

Downtime Action3 Information

ReasonInfo

action4
optional

Downtime Action4 Information

ReasonInfo

actionCommentsThreadId
optional

Action comment threadId for the downtime

integer (int64)

category
optional

The Category of the downtime record

CategoryInfo

cause1
optional

Downtime Cause1 Information

ReasonInfo

cause2
optional

Downtime Cause2 Information

ReasonInfo

cause3
optional

Downtime Cause3 Information

ReasonInfo

cause4
optional

Downtime Cause4 Information

ReasonInfo

causeCommentsThreadId
optional

Cause comment threadId for the downtime

integer (int64)

downtimeId
optional

DowntimeId

integer (int64)

duration
optional

Downtime Duration

number (double)

endTime
optional

Downtime End Time

string (date-time)

eventStatus
optional

Event Status Information

IdNameValue

faultInfo
optional

Downtime Fault Information

FaultShortInfo

links
optional

< Link > array

machineId
optional

Machine Id

integer (int64)

machineName
optional

Machine Name

string

nptId
optional

The Id of the Non-Productive Time record associated with this downtime record. Will only be present if this is a Non-Productive Time cause record.

integer (int64)

open
optional

boolean

permissions
optional

< Permission > array

product
optional

Product Information

IdNameValue

reasonsComplete
optional

boolean

startTime
optional

Downtime Start Time

string (date-time)

status
optional

Downtime Status Information

IdNameValue

upTime
optional

Machine Up Time

number (double)

3.19. DowntimeCopyReasonInfo

Name Description Schema

assetId
optional

Asset Id

integer (int64)

cause1Id
optional

Cause1 Id

integer (int64)

cause2Id
optional

Cause2 Id

integer (int64)

cause3Id
optional

Cause3 Id

integer (int64)

cause4Id
optional

Cause4 Id

integer (int64)

causeCommentThreadId
optional

CommentThreadId to be copied to the downtime records which doesn’t have cause comment and comment is required for the given set of causes. Will Be ignored if commentText is provided or is comment required is false

integer (int64)

comment
optional

If commentText is provided, this will be added to the downtime while updating reasons, if the comment is required. will be ignored if commentRequired is false.

string

commentRequired
optional

Property denoting if the comments are required for the give set of cause
Example : false

boolean

downtimeIds
optional

List of downtime Ids

< integer (int64) > array

faultId
optional

Fault Id

integer (int64)

3.20. DowntimeCreatorInfo

Name Description Schema

departmentOptions
optional

List of departments

< Resource«DepartmentInfo» > array

3.21. DowntimeCreatorMachineData

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

CollectionResource«FaultInfo»

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

CollectionResource«TopNReasonInfo»

top5Reasons
optional

Top 5 Reasons Information

CollectionResource«TopNReasonInfo»

3.22. DowntimeEditInfo

Name Description Schema

action1
optional

Action1 Reason Information

ReasonInfo

action2
optional

Action2 Reason Information

ReasonInfo

action3
optional

Action3 Reason Information

ReasonInfo

action4
optional

Action4 Reason Information

ReasonInfo

actionCommentsThreadId
optional

Action comments thread id

integer (int64)

asset
optional

Asset Information

AssetInfo

category
optional

Category Information

CategoryInfo

cause1
optional

Cause1 Reason Information

ReasonInfo

cause2
optional

Cause2 Reason Information

ReasonInfo

cause3
optional

Cause3 Reason Information

ReasonInfo

cause4
optional

Cause4 Reason Information

ReasonInfo

causeCommentsThreadId
optional

Cause comments thread id

integer (int64)

commentHistory
optional

Cause Comment History

< CommentInfo > array

department
optional

Department Information

AssetInfo

downtimeId
optional

Downtime Id

integer (int64)

duration
optional

Duration Information

number (double)

endTime
optional

End Time

string (date-time)

fault
optional

Fault Information

FaultShortInfo

line
optional

Line Information

AssetInfo

reasonsComplete
optional

Flag indication whether reasons are complete or not
Example : false

boolean

startTime
optional

Start Time

string (date-time)

3.23. DowntimeEditorOverviewInfo

Name Description Schema

actionHeaders
optional

Action Header Information

CollectionResource«ReasonHeaderInfo»

actionOptions
optional

Actions Information

CollectionResource«ReasonInfo»

downtimeRecord
optional

Downtime Edit Information

ExtendedResource«DowntimeEditInfo»

earliestPossibleTime
optional

Earliest Possible Time

string (date-time)

earliestPossibleTimeForOpenDT
optional

Earliest possible time for OpenDT

string (date-time)

faultOptions
optional

Fault Information

CollectionResource«FaultInfo»

latestPossibleTime
optional

Latest Edit Information

string (date-time)

machineOptions
optional

Machine Information

CollectionResource«AssetInfo»

nptRecord
optional

Npt Edit Information

NptEditInfo

reasonHeaders
optional

Reason Header Information

CollectionResource«ReasonHeaderInfo»

reasonOptions
optional

Reason Information

CollectionResource«ReasonInfo»

top5Actions
optional

Top 5 Actions Information

CollectionResource«TopNReasonInfo»

top5Reasons
optional

Top N Reason Information

CollectionResource«TopNReasonInfo»

3.24. DowntimeMergerSummary

Name Schema

downtimeOverviews
optional

< DowntimeOverviewInfo > array

endTime
optional

string (date-time)

startTime
optional

string (date-time)

totalDowntimeRecords
optional

integer (int32)

totalDuration
optional

number (double)

3.25. DowntimeOverviewInfo

Name Description Schema

action1
optional

Downtime Action1 Information

ReasonInfo

action2
optional

Downtime Action2 Information

ReasonInfo

action3
optional

Downtime Action3 Information

ReasonInfo

action4
optional

Downtime Action4 Information

ReasonInfo

actionCommentsThreadId
optional

Action comment threadId for the downtime

integer (int64)

category
optional

The Category of the downtime record

CategoryInfo

cause1
optional

Downtime Cause1 Information

ReasonInfo

cause2
optional

Downtime Cause2 Information

ReasonInfo

cause3
optional

Downtime Cause3 Information

ReasonInfo

cause4
optional

Downtime Cause4 Information

ReasonInfo

causeCommentsThreadId
optional

Cause comment threadId for the downtime

integer (int64)

downtimeId
optional

DowntimeId

integer (int64)

duration
optional

Downtime Duration

number (double)

endTime
optional

Downtime End Time

string (date-time)

eventStatus
optional

Event Status Information

IdNameValue

faultInfo
optional

Downtime Fault Information

FaultShortInfo

machineId
optional

Machine Id

integer (int64)

machineName
optional

Machine Name

string

nptId
optional

The Id of the Non-Productive Time record associated with this downtime record. Will only be present if this is a Non-Productive Time cause record.

integer (int64)

open
optional

boolean

product
optional

Product Information

IdNameValue

reasonsComplete
optional

boolean

startTime
optional

Downtime Start Time

string (date-time)

status
optional

Downtime Status Information

IdNameValue

upTime
optional

Machine Up Time

number (double)

3.26. DowntimeRecordUpdates

Name Description Schema

action1Id
optional

Action1 Id

integer (int64)

action2Id
optional

Action2 Id

integer (int64)

action3Id
optional

Action3 Id

integer (int64)

action4Id
optional

Action4 Id

integer (int64)

assetId
optional

Asset Id

integer (int64)

cause1Id
optional

Cause1 Id

integer (int64)

cause2Id
optional

Cause2 Id

integer (int64)

cause3Id
optional

Cause3 Id

integer (int64)

cause4Id
optional

Cause4 Id

integer (int64)

comment
optional

Comment Information

string

downtimeId
optional

Downtime Id

integer (int64)

endTime
optional

Downtime End Time

string (date-time)

faultId
optional

Fault Id

integer (int64)

nptEndTime
optional

Npt End Time

string (date-time)

nptId
optional

Npt Id

integer (int64)

nptReason1Id
optional

NPT Reason1 Id

integer (int64)

nptReason2Id
optional

NPT Reason2 Id

integer (int64)

nptReason3Id
optional

NPT Reason3 Id

integer (int64)

nptReason4Id
optional

NPT Reason4 Id

integer (int64)

nptReasonUpdated
optional

Whether NPT reasons have been updated
Example : false

boolean

startTime
optional

Downtime Start Time

string (date-time)

3.27. DowntimeViewerInfo

Name Description Schema

categories
optional

List of Categories

< CategorySummary > array

downtimeOverviews
optional

Downtime Overview Information

PagedResources«ExtendedResource«DowntimeOverviewInfo»»

filterCategories
optional

List of filter categories

< CategoryInfo > array

filterLocations
optional

List of filter locations

< AssetInfo > array

filterMaxDuration
optional

Filter Maximum Duration

number (double)

filterMinDuration
optional

Filter Minimum Duration

number (double)

3.28. Error

Name Schema

code
optional

string

details
optional

object

3.29. ExtendedResource«DowntimeEditInfo»

Name Description Schema

action1
optional

Action1 Reason Information

ReasonInfo

action2
optional

Action2 Reason Information

ReasonInfo

action3
optional

Action3 Reason Information

ReasonInfo

action4
optional

Action4 Reason Information

ReasonInfo

actionCommentsThreadId
optional

Action comments thread id

integer (int64)

asset
optional

Asset Information

AssetInfo

category
optional

Category Information

CategoryInfo

cause1
optional

Cause1 Reason Information

ReasonInfo

cause2
optional

Cause2 Reason Information

ReasonInfo

cause3
optional

Cause3 Reason Information

ReasonInfo

cause4
optional

Cause4 Reason Information

ReasonInfo

causeCommentsThreadId
optional

Cause comments thread id

integer (int64)

commentHistory
optional

Cause Comment History

< CommentInfo > array

department
optional

Department Information

AssetInfo

downtimeId
optional

Downtime Id

integer (int64)

duration
optional

Duration Information

number (double)

endTime
optional

End Time

string (date-time)

fault
optional

Fault Information

FaultShortInfo

line
optional

Line Information

AssetInfo

links
optional

< Link > array

permissions
optional

< Permission > array

reasonsComplete
optional

Flag indication whether reasons are complete or not
Example : false

boolean

startTime
optional

Start Time

string (date-time)

3.30. ExtendedResource«DowntimeOverviewInfo»

Name Description Schema

action1
optional

Downtime Action1 Information

ReasonInfo

action2
optional

Downtime Action2 Information

ReasonInfo

action3
optional

Downtime Action3 Information

ReasonInfo

action4
optional

Downtime Action4 Information

ReasonInfo

actionCommentsThreadId
optional

Action comment threadId for the downtime

integer (int64)

category
optional

The Category of the downtime record

CategoryInfo

cause1
optional

Downtime Cause1 Information

ReasonInfo

cause2
optional

Downtime Cause2 Information

ReasonInfo

cause3
optional

Downtime Cause3 Information

ReasonInfo

cause4
optional

Downtime Cause4 Information

ReasonInfo

causeCommentsThreadId
optional

Cause comment threadId for the downtime

integer (int64)

downtimeId
optional

DowntimeId

integer (int64)

duration
optional

Downtime Duration

number (double)

endTime
optional

Downtime End Time

string (date-time)

eventStatus
optional

Event Status Information

IdNameValue

faultInfo
optional

Downtime Fault Information

FaultShortInfo

links
optional

< Link > array

machineId
optional

Machine Id

integer (int64)

machineName
optional

Machine Name

string

nptId
optional

The Id of the Non-Productive Time record associated with this downtime record. Will only be present if this is a Non-Productive Time cause record.

integer (int64)

open
optional

boolean

permissions
optional

< Permission > array

product
optional

Product Information

IdNameValue

reasonsComplete
optional

boolean

startTime
optional

Downtime Start Time

string (date-time)

status
optional

Downtime Status Information

IdNameValue

upTime
optional

Machine Up Time

number (double)

3.31. FaultInfo

Name Description Schema

faultId
optional

Fault Id

integer (int64)

name
optional

Fault Name

string

reason1
optional

Downtime Reason1 Information

ReasonInfo

reason2
optional

Downtime Reason2 Information

ReasonInfo

reason3
optional

Downtime Reason3 Information

ReasonInfo

reason4
optional

Downtime Reason4 Information

ReasonInfo

3.32. FaultShortInfo

Name Description Schema

faultId
optional

Fault Id

integer (int64)

name
optional

Fault Name

string

3.33. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.34. IdNameValue

Name Description Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.35. LineInfo

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

name
optional

Name of the asset

string

units
optional

Units information Under a Line

CollectionResource«Resource«UnitInfo»»

3.36. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.37. NptCreateInfo

Name Description Schema

assetId
optional

Downtime Asset Id

integer (int64)

cause1Id
optional

Downtime Cause1 Id

integer (int64)

cause2Id
optional

Downtime Cause2 Id

integer (int64)

cause3Id
optional

Downtime Cause3 Id

integer (int64)

cause4Id
optional

Downtime Cause4 Id

integer (int64)

comment
optional

Downtime Comment Information

string

endTime
optional

Downtime End Time

string (date-time)

nptId
optional

Npt Category Id

integer (int64)

startTime
optional

Downtime Start Time

string (date-time)

3.38. NptCreatorMachineData

Name Description Schema

nptReasonHeaders
optional

Npt Reason Headers Information

CollectionResource«ReasonHeaderInfo»

nptReasonOptions
optional

Npt Reasons Options

CollectionResource«ReasonInfo»

3.39. NptEditInfo

Name Description Schema

asset
optional

Asset Information

AssetInfo

commentHistory
optional

Downtime comment history

< CommentInfo > array

department
optional

Department Information

AssetInfo

endTime
optional

Downtime End Time

string (date-time)

line
optional

Line Information

AssetInfo

nptId
optional

Npt Category Id

integer (int64)

reason1
optional

Downtime Reason1 Information

ReasonInfo

reason2
optional

Downtime Reason2 Information

ReasonInfo

reason3
optional

Downtime Reason2 Information

ReasonInfo

reason4
optional

Downtime Reason4 Information

ReasonInfo

startTime
optional

Downtime Start Time

string (date-time)

3.40. NptRecord

Name Description Schema

asset
optional

The Asset(Unit) of the NPT record

BaseAssetInfo

commentId
optional

The Comment Id of the NPT record. Points to a chain of comments.

integer (int64)

department
optional

Department of the NPT record

BaseAssetInfo

endTime
optional

The End Time of the NPT record

string (date-time)

entryOn
optional

The Entry On time of the NPT record.

string (date-time)

line
optional

Line of the NPT record

BaseAssetInfo

nptId
optional

Unique ID of the NPT record

integer (int64)

reason1
optional

The Level 1 Reason of the NPT record.

IdNameValue

reason2
optional

The Level 2 Reason of the NPT record.

IdNameValue

reason3
optional

The Level 3 Reason of the NPT record.

IdNameValue

reason4
optional

The Level 4 Reason of the NPT record.

IdNameValue

reasonTreeDataId
optional

The Reason Tree Data Id of the NPT record. This is a unique id pointing to a specific set of reasons.

integer (int64)

reasonsComplete
optional

True if all of the reason levels have been entered to the lowest required level.
Example : false

boolean

startTime
optional

The Start Time of the NPT record

string (date-time)

user
optional

The User who entered the NPT. This may be a system user if the event was generated by a service.

IdNameValue

3.41. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.42. PagedResources«ExtendedResource«DowntimeOverviewInfo»»

Name Schema

content
optional

< ExtendedResource«DowntimeOverviewInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.43. Permission

Name Schema

permissionName
optional

string

permissionValue
optional

boolean

3.44. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.45. ReasonHeaderInfo

Name Description Schema

levelName
optional

Reason level name

string

reasonLevel
optional

Reason level

integer (int32)

3.46. 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.47. Resource«DepartmentInfo»

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

lines
optional

Lines under a department

CollectionResource«Resource«LineInfo»»

links
optional

< Link > array

name
optional

Name of the asset

string

3.48. Resource«LineInfo»

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

links
optional

< Link > array

name
optional

Name of the asset

string

units
optional

Units information Under a Line

CollectionResource«Resource«UnitInfo»»

3.49. 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.50. Resource«UnitInfo»

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

lineId
optional

Line id

integer (int64)

links
optional

< Link > array

name
optional

Name of the asset

string

3.51. 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.52. 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.53. UnitInfo

Name Description Schema

assetId
optional

Id of the asset

integer (int64)

lineId
optional

Line id

integer (int64)

name
optional

Name of the asset

string

3.54. 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.55. 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. oauth

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

Name Description

default

Default oauth2 scope.