1. Overview
The Downtime service contains a collection of RESTful service calls to retrieve various information relevant to manufacturing execution.
Descriptions of these functions can be found in the section headers for each collection of relevant resources.
2. Resources
2.1. Downtime-controller
Downtime Controller
2.1.1. Create a downtime record
POST /api/downtimeRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
downtime |
Content of the downtime record to be created |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.1.2. Get all downtime records
GET /api/downtimeRecords
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 |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
filterStatusIds |
Comma seperated list of status ids.Status Id values |
string |
|
Query |
isMasterUnit |
isMasterUnit |
boolean |
|
Query |
lineIds |
Comma separated line ids |
string |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
size |
Number of records per page. |
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 |
In case of custom time selection, Start and EndTime |
enum (CurrentDay, PreviousDay, CurrentWeek, PreviousWeek, NextWeek, NextDay, Custom, CurrentShift, PreviousShift, NextShift) |
|
Query |
unitIds |
Comma separated unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
No Content |
2.1.3. Split a downtime record
PATCH /api/downtimeRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
downtimeRecords |
List of downtime records for split, including the original[first record should be the original one containing downtimeId |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DowntimeResource > array |
400 |
Invalid data supplied. See message for details. |
No Content |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.1.4. Get downtime units permission
GET /api/downtimeRecords/units/permissions
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
unitIds |
Comma separated UnitIds to get the permissions, if not provided, it will get permissions for all the downtime units |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< DowntimeUnitPermissions > array |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.1.5. Get a downtime record
GET /api/downtimeRecords/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Downtime Id for which DowntimeRecord needs to be fetched |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
No Content |
404 |
Not Found |
No Content |
2.1.6. Update a downtime record
PUT /api/downtimeRecords/{id}
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Path |
id |
Id of the downtime record to be updated |
integer (int64) |
|
Query |
mergeExistingRecords |
mergeExistingRecords |
boolean |
|
Body |
updatedDowntime |
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 |
Unauthenticated |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
409 |
Record Conflict |
|
422 |
Unprocessable Entity |
2.1.7. Delete a downtime record
DELETE /api/downtimeRecords/{id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
id |
Id of the downtime record to be deleted |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
object |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
2.2. Downtime-statistics-controller
Downtime Statistics Controller
2.2.1. Get all downtime Statistics records
GET /api/downtimeStatistics
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 |
Include Non productive time when set to false and exclude it when set to true. |
boolean |
|
Query |
filterStatusIds |
Comma seperated list of status ids.Status Id values |
string |
|
Query |
isMaster |
isMaster |
boolean |
|
Query |
lineIds |
Comma separated line ids |
string |
|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
|
Query |
size |
Number of records per page. |
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 |
In case of custom time selection, Start and EndTime |
enum (CurrentDay, PreviousDay, CurrentWeek, PreviousWeek, NextWeek, NextDay, Custom, CurrentShift, PreviousShift, NextShift) |
|
Query |
unitIds |
Comma separated unit ids |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
No Content |
401 |
Unauthenticated |
No Content |
403 |
Forbidden |
No Content |
2.3. Fault-controller
Fault Controller
2.3.1. Get all faults
GET /api/faults
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Query |
page |
Results page you want to retrieve (0..N) |
integer (int32) |
Query |
size |
Number of records per page. |
integer (int32) |
Query |
unitId |
Unit id for which faults information needs to be fetched |
integer (int64) |
3. Definitions
3.1. 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.2. CategoryStatistics
| Name | Description | Schema |
|---|---|---|
categoryDisplayName |
The display name of the category |
string |
categoryId |
Unique identifier of the category |
integer (int64) |
categoryName |
The name of the category |
string |
count |
The count of the filtered items in this category |
integer (int64) |
name |
string |
3.3. DatasetTimeCharacteristicsResource
| Name | Description | Schema |
|---|---|---|
links |
< Link > array |
|
maximumEndTime |
Maximum end time |
string (date-time) |
minimumStartTime |
Minimum start time |
string (date-time) |
minimumStartTimeForOpenDT |
minimum start time for an open downtime |
string (date-time) |
3.4. Downtime
| Name | Description | Schema |
|---|---|---|
action1 |
The Level 1 Action of the downtime record. |
|
action2 |
The Level 2 Action of the downtime record. |
|
action3 |
The Level 3 Action of the downtime record. |
|
action4 |
The Level 4 Action of the downtime record. |
|
actionCommentsThreadId |
The Action Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
asset |
The Asset(Unit) of the downtime record |
|
category |
The Category of the downtime record |
|
cause1 |
The Level 1 Cause (Reason) of the downtime record. |
|
cause2 |
The Level 2 Cause (Reason) of the downtime record. |
|
cause3 |
The Level 3 Cause (Reason) of the downtime record. |
|
cause4 |
The Level 4 Cause (Reason) of the downtime record. |
|
causeCommentsThreadId |
The Cause Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
department |
The Department of the downtime record |
|
downtimeId |
The Unique Id of the downtime record |
integer (int64) |
duration |
The Duration of the downtime record |
number (double) |
endTime |
The End Time of the downtime record |
string (date-time) |
esignatureId |
The E-Signature Id of the downtime record. Points to a Electronic signature record. |
integer (int64) |
eventStatus |
The Event Status of the downtime record |
|
fault |
The Fault of the downtime record |
|
line |
The Line of the downtime record |
|
links |
< Link > array |
|
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) |
permissions |
< Permission > array |
|
reasonTreeDataId |
The Reason Tree Data Id of the downtime record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the cause (reason) levels have been entered to the lowest required level. |
boolean |
researchCloseDate |
The Research Close Date of the downtime record. |
string (date-time) |
researchCommentsThreadId |
The Research Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
researchOpenDate |
The Research Open Date of the downtime record. |
string (date-time) |
researchStatus |
The Research Status of the downtime record. |
|
researchUser |
The Research User of the downtime record. |
|
startTime |
The Start Time of the downtime record |
string (date-time) |
status |
The Status of the downtime record |
|
uptime |
The Up Time of the downtime record |
number (double) |
user |
The User who entered the downtime record. |
3.5. DowntimeDurationFilter
| Name | Description | Schema |
|---|---|---|
maxDuration |
The maximum duration to be included in the filtered results |
number (double) |
minDuration |
The minimum duration to be included in the filtered results |
number (double) |
3.6. DowntimeLocation
| Name | Description | Schema |
|---|---|---|
asset |
The Asset (Unit) that identifies this location |
|
department |
The Department this location belongs to |
|
line |
The Line this location belongs to |
3.7. DowntimePage
| Name | Schema |
|---|---|
content |
< Downtime > array |
links |
< Link > array |
page |
3.8. DowntimeRecord
| Name | Description | Schema |
|---|---|---|
action1 |
The Level 1 Action of the downtime record. |
|
action2 |
The Level 2 Action of the downtime record. |
|
action3 |
The Level 3 Action of the downtime record. |
|
action4 |
The Level 4 Action of the downtime record. |
|
actionCommentsThreadId |
The Action Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
asset |
The Asset(Unit) of the downtime record |
|
category |
The Category of the downtime record |
|
cause1 |
The Level 1 Cause (Reason) of the downtime record. |
|
cause2 |
The Level 2 Cause (Reason) of the downtime record. |
|
cause3 |
The Level 3 Cause (Reason) of the downtime record. |
|
cause4 |
The Level 4 Cause (Reason) of the downtime record. |
|
causeCommentsThreadId |
The Cause Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
department |
The Department of the downtime record |
|
downtimeId |
The Unique Id of the downtime record |
integer (int64) |
duration |
The Duration of the downtime record |
number (double) |
endTime |
The End Time of the downtime record |
string (date-time) |
esignatureId |
The E-Signature Id of the downtime record. Points to a Electronic signature record. |
integer (int64) |
eventStatus |
The Event Status of the downtime record |
|
fault |
The Fault of the downtime record |
|
line |
The Line of the downtime record |
|
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) |
reasonTreeDataId |
The Reason Tree Data Id of the downtime record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the cause (reason) levels have been entered to the lowest required level. |
boolean |
researchCloseDate |
The Research Close Date of the downtime record. |
string (date-time) |
researchCommentsThreadId |
The Research Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
researchOpenDate |
The Research Open Date of the downtime record. |
string (date-time) |
researchStatus |
The Research Status of the downtime record. |
|
researchUser |
The Research User of the downtime record. |
|
startTime |
The Start Time of the downtime record |
string (date-time) |
status |
The Status of the downtime record |
|
uptime |
The Up Time of the downtime record |
number (double) |
user |
The User who entered the downtime record. |
3.9. DowntimeRecords
| Name | Description | Schema |
|---|---|---|
downtimeRecords |
The list of downtime records |
< DowntimeRecord > array |
3.10. DowntimeResource
| Name | Description | Schema |
|---|---|---|
action1 |
The Level 1 Action of the downtime record. |
|
action2 |
The Level 2 Action of the downtime record. |
|
action3 |
The Level 3 Action of the downtime record. |
|
action4 |
The Level 4 Action of the downtime record. |
|
actionCommentsThreadId |
The Action Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
asset |
The Asset(Unit) of the downtime record |
|
category |
The Category of the downtime record |
|
cause1 |
The Level 1 Cause (Reason) of the downtime record. |
|
cause2 |
The Level 2 Cause (Reason) of the downtime record. |
|
cause3 |
The Level 3 Cause (Reason) of the downtime record. |
|
cause4 |
The Level 4 Cause (Reason) of the downtime record. |
|
causeCommentsThreadId |
The Cause Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
department |
The Department of the downtime record |
|
downtimeId |
The Unique Id of the downtime record |
integer (int64) |
duration |
The Duration of the downtime record |
number (double) |
endTime |
The End Time of the downtime record |
string (date-time) |
esignatureId |
The E-Signature Id of the downtime record. Points to a Electronic signature record. |
integer (int64) |
eventStatus |
The Event Status of the downtime record |
|
fault |
The Fault of the downtime record |
|
line |
The Line of the downtime record |
|
links |
< Link > array |
|
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) |
reasonTreeDataId |
The Reason Tree Data Id of the downtime record. This is a unique id pointing to a specific set of reasons. |
integer (int64) |
reasonsComplete |
True if all of the cause (reason) levels have been entered to the lowest required level. |
boolean |
researchCloseDate |
The Research Close Date of the downtime record. |
string (date-time) |
researchCommentsThreadId |
The Research Comments Thread Id of the downtime record. Points to a chain of comments. |
integer (int64) |
researchOpenDate |
The Research Open Date of the downtime record. |
string (date-time) |
researchStatus |
The Research Status of the downtime record. |
|
researchUser |
The Research User of the downtime record. |
|
startTime |
The Start Time of the downtime record |
string (date-time) |
status |
The Status of the downtime record |
|
uptime |
The Up Time of the downtime record |
number (double) |
user |
The User who entered the downtime record. |
3.11. DowntimeSummary
| Name | Description | Schema |
|---|---|---|
categories |
List of category statistics. This provides counts of records available by category. |
< CategoryStatistics > array |
downtimeRecords |
Paged list of downtime records that match the request criteria |
|
filterCategories |
The categories available to filter by |
< IdNameValue > array |
filterDuration |
The duration available to filter by |
|
filterLocations |
The locations available to filter by |
< DowntimeLocation > array |
filterStatuses |
The statuses available to filter by |
< IdNameValue > array |
links |
< Link > array |
3.12. DowntimeUnitPermissions
| Name | Schema |
|---|---|
unitId |
integer (int64) |
unitPermissions |
< Permission > array |
3.14. Fault
| Name | Description | Schema |
|---|---|---|
faultId |
The Unique Id of the fault |
integer (int64) |
links |
< Link > array |
|
name |
The descriptive name of the fault |
string |
reason1 |
Level 1 reason associated with this fault |
|
reason2 |
Level 2 reason associated with this fault |
|
reason3 |
Level 3 reason associated with this fault |
|
reason4 |
Level 4 reason associated with this fault |
3.15. FaultPage
| Name | Schema |
|---|---|
content |
< Fault > array |
links |
< Link > array |
page |
3.17. IdNameValue
| Name | Description | Schema |
|---|---|---|
id |
The unique ID of the entity |
integer (int64) |
name |
The name of the entity |
string |
4. Security
4.1. access_token
Type : oauth2
Flow : accessCode
Token URL : https://localhost:8443/oauth/authorize
Token URL : https://localhost:8443/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.2. resource_owner
Type : oauth2
Flow : password
Token URL : https://localhost:8443/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.3. implicit_grant
Type : oauth2
Flow : implicit
Token URL : https://localhost:8443/oauth/authorize
| Name | Description |
|---|---|
default |
Default oauth2 scope. |
4.4. client_creds
Type : oauth2
Flow : application
Token URL : https://localhost:8443/oauth/token
| Name | Description |
|---|---|
default |
Default oauth2 scope. |