1. Overview
The service contains a collection of RESTful service calls relating to Process Order from the Plant apps serverDescriptions of these functions can be found in the section headers for each collection of relevant resources.
1.1. URI scheme
Host : localhost
BasePath : /
1.2. Tags
-
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 |
Color Scheme Id to retrieve the Color Scheme Fields. |
integer (int64) |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.2. Comment-controller
Comment Controller
2.2.1. Add a comment
POST /comments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
commentType |
Parameter specifying the type of comment. |
enum (DowntimeCause, DowntimeAction, NonProductiveDetail) |
Query |
rootId |
id of the entity to which comments are to be added, it can be downtimeId or nptId. |
integer (int64) |
Body |
commentInfo |
commentInfo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.2.2. Get the history of comments for the given root id
GET /comments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
commentType |
Parameter specifying the type of comment. |
enum (DowntimeCause, DowntimeAction, NonProductiveDetail) |
Query |
rootId |
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.2.3. Update a comment
PUT /comments
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
commentType |
Parameter specifying the type of comment. |
enum (DowntimeCause, DowntimeAction, NonProductiveDetail) |
Query |
rootId |
id of the entity of which comment is to be updated, it can be downtimeId or nptId. |
integer (int64) |
Body |
commentInfo |
commentInfo |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.2.4. Get the details of a comment
GET /comments/{commentId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
commentId |
commentId |
integer (int64) |
Query |
commentType |
Parameter specifying the type of comment. |
enum (DowntimeCause, DowntimeAction, NonProductiveDetail) |
Query |
rootId |
id of the entity for which comment is required, it can be downtimeId or nptId. |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.2.5. Delete the downtime comment
DELETE /comments/{commentId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
commentId |
commentId |
integer (int64) |
Query |
commentType |
Parameter specifying the type of comment. |
enum (DowntimeCause, DowntimeAction, NonProductiveDetail) |
Query |
rootId |
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
filterCategoryIds |
Comma seperated list of category ids |
string |
|
Query |
filterLocationIds |
Comma seperated list of location ids |
string |
|
Query |
filterMaxDuration |
Maximum duration of downtime |
number (double) |
|
Query |
filterMinDuration |
Minimum duration of downtime |
number (double) |
|
Query |
filterNptOnly |
Flag to filter Non Productive Time records |
boolean |
|
Query |
filterStatusIds |
Comma seperated list of status ids.Status Id values |
string |
|
Query |
page |
Results page number to retrieve |
integer (int32) |
|
Query |
size |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
sort |
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. |
string |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
unitIds |
Comma separated list of unit ids |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.3.2. Copying reasons for downtime records
PUT /downtime-viewer/copy-reasons
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
downtimeCopyReasonInfo |
cause reasons to be copied |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json;charset=UTF-8
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.3.3. Get a downtime record
GET /downtime-viewer/downtimeRecord/{id}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
id |
Downtime Id |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
End time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
filterCategoryIds |
Comma seperated list of category ids |
string |
|
Query |
filterLocationIds |
Comma seperated list of location ids |
string |
|
Query |
filterMaxDuration |
Maximum duration of downtime |
number (double) |
|
Query |
filterMinDuration |
Minimum duration of downtime |
number (double) |
|
Query |
filterNptOnly |
Flag to filter Non Productive Time records |
boolean |
|
Query |
filterStatusIds |
Comma seperated list of status ids.Status Id values |
string |
|
Query |
page |
Results page number to retrieve |
integer (int32) |
|
Query |
size |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
sort |
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. |
string |
|
Query |
startTime |
Start time in ISO-8601 format(YYYY-MM-DDThh:mm:ssZ), in case of custom time selection |
string (date-time) |
|
Query |
timeSelection |
Time selection values |
integer (int64) |
|
Query |
unitIds |
Comma separated list of unit ids |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Downtime Id for which information needs to be fetched |
integer (int64) |
|
Query |
expandFaults |
Flag specifying whether the Fault Options should be retrieved and populated |
boolean |
|
Query |
expandMachines |
Flag indicating whether the Machines Options should be retrieved and populated |
boolean |
|
Query |
expandReasons |
Flag indicating whether the Reasons Options should be retrieved and populated |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.4.2. Updates an existing downtime record with the given downtime id
PUT /downtime-editor
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
downtimeId |
Id of the downtime record to be updated |
integer (int64) |
Body |
downtimeRecordUpdates |
Content of the downtime record to be updated |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.4.3. Deletes a record with the given downtime id
DELETE /downtime-editor
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
downtimeId |
Id of the downtime record to be deleted |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Produces
-
/
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Unit id for which actions and headers information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.4.5. Fetches actions information for the given unit id
GET /downtime-editor/actions
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
unitId |
Unit id for which actions information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.4.6. Fetches faults information for the given unit id
GET /downtime-editor/faults
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
unitId |
Unit id for which faults information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Unit id for which machines information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Id of the downtime record to be merged |
integer (int64) |
Body |
downtimeRecordUpdates |
Content of the downtime record to be merged |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.4.9. Fetches reasons information for the given unit id
GET /downtime-editor/reasons
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
unitId |
Unit id for which reasons information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Unit id for which reasons and header information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
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 |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
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 |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
The earliest downtime record id |
integer (int64) |
|
Query |
latestDowntimeId |
The latest downtime record id |
integer (int64) |
|
Query |
page |
Results page number to retrieve |
integer (int32) |
|
Query |
size |
Number of records per page, from 1 to 500 |
integer (int32) |
|
Query |
sort |
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. |
string |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
The id specifying the downtime record to be merged |
integer (int64) |
Body |
downtimeRecordUpdates |
Content of the downtime record to be merged |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
Content of the downtime record to be created |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.6.2. Fetches departments,lines and units information
GET /downtime-creator
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
expandLines |
Flag specifying whether lines information needs to be included under departments |
boolean |
|
Query |
expandUnits |
Flag specifying whether units information needs to be included under lines |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
department id for which lines information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
line id for which units information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.6.5. Fetches Locations for given Unit ID
GET /downtime-creator/locations
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
masterUnitId |
masterUnitId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
string |
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.6.6. Fetches reasons and fault information for the given unit Id
GET /downtime-creator/units/{unitId}/machineData
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path |
unitId |
Unit id for which reasons and faults information needs to be fetched |
integer (int64) |
|
Query |
expandFaults |
Flag to indicate whether faults information should be included in the response |
boolean |
|
Query |
expandReasons |
Flag to indicate whether reasons information should be included in the response |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
downtime id for which the edit state information needs to be fetched for splitting |
integer (int64) |
|
Query |
expandReasons |
Flag to indicate whether the reasons information should be retrieved and populated |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.7.2. Splits Downtime Record
PATCH /downtime-splitter
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
downtimeRecordUpdates |
The updates to make to the downtime record |
< DowntimeRecordUpdates > array |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
|
204 |
No Content, no service exists |
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.8.2. Get status for rabbit mq
GET /monitoring-viewer/rmqStatus
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
204 |
No Content, no service exists |
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
onlyDowntimeAddPermissionUnits |
Set to true if only downtime add permission units are required |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
The updates to make to the non-productive record |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
enum (100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED) |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
Consumes
-
application/json
Produces
-
application/json;charset=UTF-8
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.10.2. Fetches departments, lines and units information
GET /npt-creator
Parameters
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Query |
expandLines |
Flag specifying whether lines information needs to be included under departments |
boolean |
|
Query |
expandUnits |
Flag specifying whether units information needs to be included under lines |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
department id for which lines information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
line id for which units information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
unit id for which reasons and header information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
unit id for which the non-productive downtime reasons information needs to be fetched |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
unit id for which reasons and headers information needs to be fetched |
integer (int64) |
|
Query |
expandReasons |
Flag to indicate whether the reasons information should be retrieved and populated |
boolean |
|
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.10.8. Fetches Npt record
GET /npt-creator/{nptId}
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
nptId |
nptId |
integer (int64) |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
Ok |
|
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 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
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 |
User Setting Object |
Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
204 |
No Content, Error retrieving created user settings |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
App ID not found in privilege set |
|
409 |
Conflict, User Setting already exists. Use a PUT to update |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.11.2. Get User settings for the logged in User
GET /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
Produces
-
application/json
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.11.3. Update User settings for the logged in user
PUT /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
request |
User Preference Object |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, There is no saved User settings for the logged in user |
|
500 |
Internal Server Error |
Consumes
-
application/json
Produces
-
application/json
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.11.4. Delete User settings for the logged in user
DELETE /v2/settings
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
appId |
appId |
integer (int32) |
Query |
viewName |
viewName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
204 |
Success |
string |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not Found, User Setting not found |
|
500 |
Internal Server Error |
Produces
-
application/json
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
2.11.5. Get Privilege Sets
GET /v2/settings/apps
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
appName |
appName |
string |
Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
< PrivilegeSet > array |
400 |
Invalid data supplied |
|
401 |
User Unauthorized |
No Content |
404 |
Not found, no user setting found for the user |
|
500 |
Internal Server Error |
Produces
-
application/json
Security
Type | Name | Scopes |
---|---|---|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
|
oauth2 |
default |
3. Definitions
3.1. AssetInfo
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
name |
Name of the asset |
string |
3.2. BaseAssetInfo
Name | Description | Schema |
---|---|---|
assetId |
The asset ID |
integer (int64) |
name |
The name of the asset |
string |
type |
The type of the asset |
enum (Department, Line, Unit, Group, Variable, ProcessOrder) |
3.3. CategoryInfo
Name | Description | Schema |
---|---|---|
categoryId |
Id of the Category |
integer (int64) |
name |
Name of the Category |
string |
3.4. CategorySummary
Name | Description | Schema |
---|---|---|
categoryIds |
List of the Category Ids having the Category Name |
< integer (int64) > array |
count |
Count of the Category in the Page |
integer (int64) |
name |
Name of the Category |
string |
3.5. CollectionMetadata
Name | Schema |
---|---|
totalElements |
integer (int32) |
3.6. CollectionResource«AssetInfo»
Name | Schema |
---|---|
collection |
|
content |
< AssetInfo > array |
links |
3.7. CollectionResource«EntityModel«LineInfo»»
Name | Schema |
---|---|
collection |
|
content |
< EntityModel«LineInfo» > array |
links |
3.8. CollectionResource«EntityModel«UnitInfo»»
Name | Schema |
---|---|
collection |
|
content |
< EntityModel«UnitInfo» > array |
links |
3.9. CollectionResource«FaultInfo»
Name | Schema |
---|---|
collection |
|
content |
< FaultInfo > array |
links |
3.10. CollectionResource«ReasonHeaderInfo»
Name | Schema |
---|---|
collection |
|
content |
< ReasonHeaderInfo > array |
links |
3.11. CollectionResource«ReasonInfo»
Name | Schema |
---|---|
collection |
|
content |
< ReasonInfo > array |
links |
3.12. CollectionResource«TopNReasonInfo»
Name | Schema |
---|---|
collection |
|
content |
< TopNReasonInfo > array |
links |
3.13. ColorSchemeFieldInfo
Name | Description | Schema |
---|---|---|
category |
Category of the Color Scheme Field. |
enum (AutologCellForeground, AutologCellBackground, Spreadsheet, Trendsheet, DelayReports, QualityReports, COAReports, OtherReports, ProficyWebCharts, Downtime, Waste) |
color |
Color Code. |
string |
colorSchemeFieldDesc |
string |
|
colorSchemeFieldId |
integer (int64) |
|
colorSchemeInfo |
Color Scheme to which Color Scheme Field belongs to. |
3.14. ColorSchemeFieldInfoResources
Name | Schema |
---|---|
content |
< ColorSchemeFieldInfo > array |
links |
3.15. ColorSchemeInfo
Name | Schema |
---|---|
colorSchemeDesc |
string |
colorSchemeId |
integer (int64) |
3.16. CommentInfo
Name | Description | Schema |
---|---|---|
commentId |
Id for Comment |
integer (int64) |
commentText |
Comment Content |
string |
commentTime |
Time of the Comment |
string (date-time) |
threadId |
Id for Thread |
integer (int64) |
user |
User Details |
3.17. DepartmentInfo
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
lines |
Lines under a department |
|
name |
Name of the asset |
string |
3.18. Downtime
Name | Description | Schema |
---|---|---|
action1 |
Downtime Action1 Information |
|
action2 |
Downtime Action2 Information |
|
action3 |
Downtime Action3 Information |
|
action4 |
Downtime Action4 Information |
|
actionCommentsThreadId |
Action comment threadId for the downtime |
integer (int64) |
category |
The Category of the downtime record |
|
cause1 |
Downtime Cause1 Information |
|
cause2 |
Downtime Cause2 Information |
|
cause3 |
Downtime Cause3 Information |
|
cause4 |
Downtime Cause4 Information |
|
causeCommentsThreadId |
Cause comment threadId for the downtime |
integer (int64) |
downtimeId |
DowntimeId |
integer (int64) |
duration |
Downtime Duration |
number (double) |
endTime |
Downtime End Time |
string (date-time) |
eventStatus |
Event Status Information |
|
faultInfo |
Downtime Fault Information |
|
links |
||
machineId |
Machine Id |
integer (int64) |
machineName |
Machine Name |
string |
nptId |
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 |
boolean |
|
permissions |
< Permission > array |
|
product |
Product Information |
|
reasonsComplete |
boolean |
|
startTime |
Downtime Start Time |
string (date-time) |
status |
Downtime Status Information |
|
upTime |
Machine Up Time |
number (double) |
3.19. DowntimeCopyReasonInfo
Name | Description | Schema |
---|---|---|
assetId |
Asset Id |
integer (int64) |
cause1Id |
Cause1 Id |
integer (int64) |
cause2Id |
Cause2 Id |
integer (int64) |
cause3Id |
Cause3 Id |
integer (int64) |
cause4Id |
Cause4 Id |
integer (int64) |
causeCommentThreadId |
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 |
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 |
Property denoting if the comments are required for the give set of cause |
boolean |
downtimeIds |
List of downtime Ids |
< integer (int64) > array |
faultId |
Fault Id |
integer (int64) |
3.20. DowntimeCreatorInfo
Name | Description | Schema |
---|---|---|
departmentOptions |
List of departments |
< EntityModel«DepartmentInfo» > array |
3.21. DowntimeCreatorMachineData
Name | Description | Schema |
---|---|---|
actionHeaders |
Reason Header Information |
|
actionOptions |
Reason Information |
|
earliestPossibleTime |
Earliest Possible Time |
string (date-time) |
faultOptions |
Fault Information |
|
latestPossibleTime |
Latest Possible Time |
string (date-time) |
reasonHeaders |
Reason Header Information |
|
reasonOptions |
Reason Information |
|
top5Actions |
Top 5 Actions Information |
|
top5Reasons |
Top 5 Reasons Information |
3.22. DowntimeEditInfo
Name | Description | Schema |
---|---|---|
action1 |
Action1 Reason Information |
|
action2 |
Action2 Reason Information |
|
action3 |
Action3 Reason Information |
|
action4 |
Action4 Reason Information |
|
actionCommentsThreadId |
Action comments thread id |
integer (int64) |
asset |
Asset Information |
|
category |
Category Information |
|
cause1 |
Cause1 Reason Information |
|
cause2 |
Cause2 Reason Information |
|
cause3 |
Cause3 Reason Information |
|
cause4 |
Cause4 Reason Information |
|
causeCommentsThreadId |
Cause comments thread id |
integer (int64) |
commentHistory |
Cause Comment History |
< CommentInfo > array |
department |
Department Information |
|
downtimeId |
Downtime Id |
integer (int64) |
duration |
Duration Information |
number (double) |
endTime |
End Time |
string (date-time) |
fault |
Fault Information |
|
line |
Line Information |
|
reasonsComplete |
Flag indication whether reasons are complete or not |
boolean |
startTime |
Start Time |
string (date-time) |
3.23. DowntimeEditorOverviewInfo
Name | Description | Schema |
---|---|---|
actionHeaders |
Action Header Information |
|
actionOptions |
Actions Information |
|
downtimeRecord |
Downtime Edit Information |
|
earliestPossibleTime |
Earliest Possible Time |
string (date-time) |
earliestPossibleTimeForOpenDT |
Earliest possible time for OpenDT |
string (date-time) |
faultOptions |
Fault Information |
|
latestPossibleTime |
Latest Edit Information |
string (date-time) |
machineOptions |
Machine Information |
|
nptRecord |
Npt Edit Information |
|
reasonHeaders |
Reason Header Information |
|
reasonOptions |
Reason Information |
|
top5Actions |
Top 5 Actions Information |
|
top5Reasons |
Top N Reason Information |
3.24. DowntimeMergerSummary
Name | Schema |
---|---|
downtimeOverviews |
< DowntimeOverviewInfo > array |
endTime |
string (date-time) |
startTime |
string (date-time) |
totalDowntimeRecords |
integer (int32) |
totalDuration |
number (double) |
3.25. DowntimeOverviewInfo
Name | Description | Schema |
---|---|---|
action1 |
Downtime Action1 Information |
|
action2 |
Downtime Action2 Information |
|
action3 |
Downtime Action3 Information |
|
action4 |
Downtime Action4 Information |
|
actionCommentsThreadId |
Action comment threadId for the downtime |
integer (int64) |
category |
The Category of the downtime record |
|
cause1 |
Downtime Cause1 Information |
|
cause2 |
Downtime Cause2 Information |
|
cause3 |
Downtime Cause3 Information |
|
cause4 |
Downtime Cause4 Information |
|
causeCommentsThreadId |
Cause comment threadId for the downtime |
integer (int64) |
downtimeId |
DowntimeId |
integer (int64) |
duration |
Downtime Duration |
number (double) |
endTime |
Downtime End Time |
string (date-time) |
eventStatus |
Event Status Information |
|
faultInfo |
Downtime Fault Information |
|
machineId |
Machine Id |
integer (int64) |
machineName |
Machine Name |
string |
nptId |
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 |
boolean |
|
product |
Product Information |
|
reasonsComplete |
boolean |
|
startTime |
Downtime Start Time |
string (date-time) |
status |
Downtime Status Information |
|
upTime |
Machine Up Time |
number (double) |
3.26. DowntimeRecordUpdates
Name | Description | Schema |
---|---|---|
action1Id |
Action1 Id |
integer (int64) |
action2Id |
Action2 Id |
integer (int64) |
action3Id |
Action3 Id |
integer (int64) |
action4Id |
Action4 Id |
integer (int64) |
assetId |
Asset Id |
integer (int64) |
cause1Id |
Cause1 Id |
integer (int64) |
cause2Id |
Cause2 Id |
integer (int64) |
cause3Id |
Cause3 Id |
integer (int64) |
cause4Id |
Cause4 Id |
integer (int64) |
causeCommentId |
Cause Comment Id |
integer (int64) |
causeCommentsThreadId |
Cause Comment Thread Id |
integer (int64) |
comment |
Comment Information |
string |
downtimeId |
Downtime Id |
integer (int64) |
endTime |
Downtime End Time |
string (date-time) |
faultId |
Fault Id |
integer (int64) |
nptEndTime |
Npt End Time |
string (date-time) |
nptId |
Npt Id |
integer (int64) |
nptReason1Id |
NPT Reason1 Id |
integer (int64) |
nptReason2Id |
NPT Reason2 Id |
integer (int64) |
nptReason3Id |
NPT Reason3 Id |
integer (int64) |
nptReason4Id |
NPT Reason4 Id |
integer (int64) |
nptReasonUpdated |
Whether NPT reasons have been updated |
boolean |
startTime |
Downtime Start Time |
string (date-time) |
3.27. DowntimeViewerInfo
Name | Description | Schema |
---|---|---|
categories |
List of Categories |
< CategorySummary > array |
downtimeOverviews |
Downtime Overview Information |
|
filterCategories |
List of filter categories |
< CategoryInfo > array |
filterLocations |
List of filter locations |
< AssetInfo > array |
filterMaxDuration |
Filter Maximum Duration |
number (double) |
filterMinDuration |
Filter Minimum Duration |
number (double) |
3.28. EntityModel«DepartmentInfo»
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
lines |
Lines under a department |
|
links |
||
name |
Name of the asset |
string |
3.29. EntityModel«LineInfo»
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
links |
||
name |
Name of the asset |
string |
units |
Units information Under a Line |
3.30. EntityModel«ServiceHealthStatus»
Name | Description | Schema |
---|---|---|
isRunning |
The status of the service. Returns true if running, else false |
boolean |
links |
||
reason |
Reason why the service is not running. Returned only when the service is down and if there is a reason for failure |
string |
3.31. EntityModel«UnitInfo»
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
isSlave |
Is Slave |
integer (int32) |
lineId |
Line id |
integer (int64) |
links |
||
name |
Name of the asset |
string |
3.32. Error
Name | Schema |
---|---|
code |
string |
details |
object |
3.33. ExtendedResource«DowntimeEditInfo»
Name | Description | Schema |
---|---|---|
action1 |
Action1 Reason Information |
|
action2 |
Action2 Reason Information |
|
action3 |
Action3 Reason Information |
|
action4 |
Action4 Reason Information |
|
actionCommentsThreadId |
Action comments thread id |
integer (int64) |
asset |
Asset Information |
|
category |
Category Information |
|
cause1 |
Cause1 Reason Information |
|
cause2 |
Cause2 Reason Information |
|
cause3 |
Cause3 Reason Information |
|
cause4 |
Cause4 Reason Information |
|
causeCommentsThreadId |
Cause comments thread id |
integer (int64) |
commentHistory |
Cause Comment History |
< CommentInfo > array |
department |
Department Information |
|
downtimeId |
Downtime Id |
integer (int64) |
duration |
Duration Information |
number (double) |
endTime |
End Time |
string (date-time) |
fault |
Fault Information |
|
line |
Line Information |
|
links |
||
permissions |
< Permission > array |
|
reasonsComplete |
Flag indication whether reasons are complete or not |
boolean |
startTime |
Start Time |
string (date-time) |
3.34. ExtendedResource«DowntimeOverviewInfo»
Name | Description | Schema |
---|---|---|
action1 |
Downtime Action1 Information |
|
action2 |
Downtime Action2 Information |
|
action3 |
Downtime Action3 Information |
|
action4 |
Downtime Action4 Information |
|
actionCommentsThreadId |
Action comment threadId for the downtime |
integer (int64) |
category |
The Category of the downtime record |
|
cause1 |
Downtime Cause1 Information |
|
cause2 |
Downtime Cause2 Information |
|
cause3 |
Downtime Cause3 Information |
|
cause4 |
Downtime Cause4 Information |
|
causeCommentsThreadId |
Cause comment threadId for the downtime |
integer (int64) |
downtimeId |
DowntimeId |
integer (int64) |
duration |
Downtime Duration |
number (double) |
endTime |
Downtime End Time |
string (date-time) |
eventStatus |
Event Status Information |
|
faultInfo |
Downtime Fault Information |
|
links |
||
machineId |
Machine Id |
integer (int64) |
machineName |
Machine Name |
string |
nptId |
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 |
boolean |
|
permissions |
< Permission > array |
|
product |
Product Information |
|
reasonsComplete |
boolean |
|
startTime |
Downtime Start Time |
string (date-time) |
status |
Downtime Status Information |
|
upTime |
Machine Up Time |
number (double) |
3.35. FaultInfo
Name | Description | Schema |
---|---|---|
faultId |
Fault Id |
integer (int64) |
name |
Fault Name |
string |
reason1 |
Downtime Reason1 Information |
|
reason2 |
Downtime Reason2 Information |
|
reason3 |
Downtime Reason3 Information |
|
reason4 |
Downtime Reason4 Information |
3.36. FaultShortInfo
Name | Description | Schema |
---|---|---|
faultId |
Fault Id |
integer (int64) |
name |
Fault Name |
string |
3.37. HttpErrorResponse
Name | Schema |
---|---|
error |
|
path |
string |
timestamp |
string |
3.38. IdNameValue
Name | Description | Schema |
---|---|---|
id |
The unique ID of the entity |
integer (int64) |
name |
The name of the entity |
string |
3.39. LineInfo
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
name |
Name of the asset |
string |
units |
Units information Under a Line |
3.40. Link
Name | Description | Schema |
---|---|---|
deprecation |
string |
|
href |
string |
|
hreflang |
string |
|
media |
string |
|
name |
string |
|
profile |
string |
|
rel |
string |
|
template |
||
templated |
Example : |
boolean |
title |
string |
|
type |
string |
3.41. Links
Name | Schema |
---|---|
empty |
boolean |
3.42. NptCreateInfo
Name | Description | Schema |
---|---|---|
assetId |
Downtime Asset Id |
integer (int64) |
cause1Id |
Downtime Cause1 Id |
integer (int64) |
cause2Id |
Downtime Cause2 Id |
integer (int64) |
cause3Id |
Downtime Cause3 Id |
integer (int64) |
cause4Id |
Downtime Cause4 Id |
integer (int64) |
causeCommentId |
NPT Cause Comment Id |
integer (int64) |
causeCommentThreadId |
NPT Cause Comment Thread Id |
integer (int64) |
comment |
Downtime Comment Information |
string |
endTime |
Downtime End Time |
string (date-time) |
nptId |
Npt Category Id |
integer (int64) |
startTime |
Downtime Start Time |
string (date-time) |
3.43. NptCreatorMachineData
Name | Description | Schema |
---|---|---|
nptReasonHeaders |
Npt Reason Headers Information |
|
nptReasonOptions |
Npt Reasons Options |
3.44. NptEditInfo
Name | Description | Schema |
---|---|---|
asset |
Asset Information |
|
commentHistory |
Downtime comment history |
< CommentInfo > array |
department |
Department Information |
|
endTime |
Downtime End Time |
string (date-time) |
line |
Line Information |
|
nptId |
Npt Category Id |
integer (int64) |
reason1 |
Downtime Reason1 Information |
|
reason2 |
Downtime Reason2 Information |
|
reason3 |
Downtime Reason2 Information |
|
reason4 |
Downtime Reason4 Information |
|
startTime |
Downtime Start Time |
string (date-time) |
3.45. NptRecord
Name | Description | Schema |
---|---|---|
asset |
The Asset(Unit) of the NPT record |
|
commentId |
The Comment Id of the NPT record. Points to a chain of comments. |
integer (int64) |
department |
Department of the NPT record |
|
endTime |
The End Time of the NPT record |
string (date-time) |
entryOn |
The Entry On time of the NPT record. |
string (date-time) |
line |
Line of the NPT record |
|
nptId |
Unique ID of the NPT record |
integer (int64) |
reason1 |
The Level 1 Reason of the NPT record. |
|
reason2 |
The Level 2 Reason of the NPT record. |
|
reason3 |
The Level 3 Reason of the NPT record. |
|
reason4 |
The Level 4 Reason of the NPT record. |
|
reasonTreeDataId |
The Reason Tree Data Id of the NPT record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the reason levels have been entered to the lowest required level. |
boolean |
startTime |
The Start Time of the NPT record |
string (date-time) |
user |
The User who entered the NPT. This may be a system user if the event was generated by a service. |
3.46. PageMetadata
Name | Schema |
---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.47. PagedModel«ExtendedResource«DowntimeOverviewInfo»»
Name | Schema |
---|---|
content |
< ExtendedResource«DowntimeOverviewInfo» > array |
links |
|
page |
3.48. Permission
Name | Schema |
---|---|
permissionName |
string |
permissionValue |
boolean |
3.49. PrivilegeSet
Name | Schema |
---|---|
category |
string |
description |
string |
displayName |
string |
icon |
string |
id |
integer (int32) |
scope |
string |
3.50. ReasonHeaderInfo
Name | Description | Schema |
---|---|---|
levelName |
Reason level name |
string |
reasonLevel |
Reason level |
integer (int32) |
3.51. ReasonInfo
Name | Description | Schema |
---|---|---|
categoryId |
Downtime Category Id |
integer (int64) |
categoryName |
Downtime Category Name |
string |
children |
Child Reason Information |
< ReasonInfo > array |
commentRequired |
boolean |
|
nodeId |
Reason Node Id |
integer (int64) |
parentNodeId |
Reason Parent Node Id |
integer (int64) |
reasonId |
Reason Id |
integer (int64) |
reasonName |
Reason Name |
string |
treeId |
Reason Tree Id |
integer (int64) |
3.52. ServiceHealthStatus
Name | Description | Schema |
---|---|---|
isRunning |
The status of the service. Returns true if running, else false |
boolean |
reason |
Reason why the service is not running. Returned only when the service is down and if there is a reason for failure |
string |
3.53. TemplateVariable
Name | Schema |
---|---|
description |
string |
name |
string |
type |
enum (, ?, &, /, #, *) |
3.54. TopNReasonInfo
Name | Description | Schema |
---|---|---|
level1 |
Reason Information Level 1 |
|
level2 |
Reason Information Level 2 |
|
level3 |
Reason Information Level 3 |
|
level4 |
Reason Information Level 4 |
3.55. UnitInfo
Name | Description | Schema |
---|---|---|
assetId |
Id of the asset |
integer (int64) |
isSlave |
Is Slave |
integer (int32) |
lineId |
Line id |
integer (int64) |
name |
Name of the asset |
string |
3.56. UriTemplate
Name | Schema |
---|---|
variableNames |
< string > array |
variables |
< TemplateVariable > array |
3.57. UserSettingRequest
Name | Description | Schema |
---|---|---|
appId |
integer (int32) |
|
data |
The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} } |
object |
viewName |
string |
3.58. UserSettingResponseResource
Name | Description | Schema |
---|---|---|
appId |
integer (int32) |
|
data |
object |
|
defaultSetting |
Example : |
boolean |
links |
< Link > array |
|
viewName |
string |
4. Security
4.1. access_token
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. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : http://10.181.213.148:8080/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : http://10.181.213.148:8080/uaa/oauth/authorize
Name | Description |
---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : http://10.181.213.148:8080/uaa/oauth/token
Name | Description |
---|---|
default |
Default oauth2 scope. |