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.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • downtime-controller : Downtime Controller

  • downtime-statistics-controller : Downtime Statistics Controller

  • fault-controller : Fault Controller

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
optional

Content of the downtime record to be created

DowntimeRecord
Responses
HTTP Code Description Schema

201

Created

Downtime

400

Invalid data supplied. See message for details.

No Content

401

Unauthenticated

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

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

  • application/json;charset=UTF-8

Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get all downtime records

GET /api/downtimeRecords
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

Include Non productive time when set to false and exclude it when set to true.

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

isMasterUnit
optional

isMasterUnit

boolean

"true"

Query

lineIds
optional

Comma separated line ids

string

Query

page
optional

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

integer (int32)

0

Query

size
optional

Number of records per page.

integer (int32)

20

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

In case of custom time selection, Start and EndTime
are required parameters

enum (CurrentDay, PreviousDay, CurrentWeek, PreviousWeek, NextWeek, NextDay, Custom, CurrentShift, PreviousShift, NextShift)

Query

unitIds
optional

Comma separated unit ids

string
Responses
HTTP Code Description Schema

200

OK

DowntimePage

400

Bad Request

No Content

401

Unauthenticated

No Content

403

Forbidden

No Content
Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. Split a downtime record

PATCH /api/downtimeRecords
Parameters
Type Name Description Schema

Body

downtimeRecords
optional

List of downtime records for split, including the original[first record should be the original one containing downtimeId
Other records should not have downtime Ids. They will be added as new downtimes and original dt record will be updated]

DowntimeRecords
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

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

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

  • application/json;charset=UTF-8

Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Get downtime units permission

GET /api/downtimeRecords/units/permissions
Parameters
Type Name Description Schema

Query

unitIds
optional

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
Produces

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

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Get a downtime record

GET /api/downtimeRecords/{id}
Parameters
Type Name Description Schema

Path

id
optional

Downtime Id for which DowntimeRecord needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Downtime

401

Unauthenticated

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

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

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.6. Update a downtime record

PUT /api/downtimeRecords/{id}
Parameters
Type Name Description Schema Default

Path

id
required

Id of the downtime record to be updated

integer (int64)

Query

mergeExistingRecords
optional

mergeExistingRecords

boolean

"false"

Body

updatedDowntime
optional

Content of the downtime record to be updated

DowntimeRecord
Responses
HTTP Code Description Schema

200

OK

Downtime

400

Invalid data supplied. See message for details.

No Content

401

Unauthenticated

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Record Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

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

  • application/json;charset=UTF-8

Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.7. Delete a downtime record

DELETE /api/downtimeRecords/{id}
Parameters
Type Name Description Schema

Path

id
required

Id of the downtime record to be deleted

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthenticated

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • */*

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.8. Get available edit times

GET /api/downtimeRecords/{id}/availableEditTimes
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

DatasetTimeCharacteristicsResource

401

Unauthenticated

No Content

403

Forbidden

No Content

404

Not Found

No Content
Produces

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

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

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

Include Non productive time when set to false and exclude it when set to true.

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

isMaster
optional

isMaster

boolean

Query

lineIds
optional

Comma separated line ids

string

Query

page
optional

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

integer (int32)

0

Query

size
optional

Number of records per page.

integer (int32)

20

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
required

In case of custom time selection, Start and EndTime
are required parameters

enum (CurrentDay, PreviousDay, CurrentWeek, PreviousWeek, NextWeek, NextDay, Custom, CurrentShift, PreviousShift, NextShift)

Query

unitIds
optional

Comma separated unit ids

string
Responses
HTTP Code Description Schema

200

OK

DowntimeSummary

400

Bad Request

No Content

401

Unauthenticated

No Content

403

Forbidden

No Content
Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Fault-controller

Fault Controller

2.3.1. Get all faults

GET /api/faults
Parameters
Type Name Description Schema

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

Query

unitId
required

Unit id for which faults information needs to be fetched

integer (int64)
Responses
HTTP Code Description Schema

200

OK

FaultPage

401

Unauthenticated

No Content
Produces

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

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.2. Get a fault

GET /api/faults/{id}
Parameters
Type Name Description Schema

Path

id
required

Fault Id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Fault

401

Unauthenticated

No Content

404

Not Found

No Content
Produces

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

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. 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.2. CategoryStatistics

Name Description Schema

categoryDisplayName
optional

The display name of the category

string

categoryId
optional

Unique identifier of the category

integer (int64)

categoryName
optional

The name of the category

string

count
optional

The count of the filtered items in this category

integer (int64)

name
optional

string

3.3. DatasetTimeCharacteristicsResource

Name Description Schema

links
optional

< Link > array

maximumEndTime
optional

Maximum end time

string (date-time)

minimumStartTime
optional

Minimum start time

string (date-time)

minimumStartTimeForOpenDT
optional

minimum start time for an open downtime

string (date-time)

3.4. Downtime

Name Description Schema

action1
optional

The Level 1 Action of the downtime record.

TreeNodeInfo

action2
optional

The Level 2 Action of the downtime record.

TreeNodeInfo

action3
optional

The Level 3 Action of the downtime record.

TreeNodeInfo

action4
optional

The Level 4 Action of the downtime record.

TreeNodeInfo

actionCommentsThreadId
optional

The Action Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

asset
optional

The Asset(Unit) of the downtime record

BaseAssetInfo

category
optional

The Category of the downtime record

IdNameValue

cause1
optional

The Level 1 Cause (Reason) of the downtime record.

TreeNodeInfo

cause2
optional

The Level 2 Cause (Reason) of the downtime record.

TreeNodeInfo

cause3
optional

The Level 3 Cause (Reason) of the downtime record.

TreeNodeInfo

cause4
optional

The Level 4 Cause (Reason) of the downtime record.

TreeNodeInfo

causeCommentsThreadId
optional

The Cause Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

department
optional

The Department of the downtime record

BaseAssetInfo

downtimeId
optional

The Unique Id of the downtime record

integer (int64)

duration
optional

The Duration of the downtime record

number (double)

endTime
optional

The End Time of the downtime record

string (date-time)

esignatureId
optional

The E-Signature Id of the downtime record. Points to a Electronic signature record.

integer (int64)

eventStatus
optional

The Event Status of the downtime record

IdNameValue

fault
optional

The Fault of the downtime record

IdNameValue

line
optional

The Line of the downtime record

BaseAssetInfo

links
optional

< Link > array

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)

permissions
optional

< Permission > array

reasonTreeDataId
optional

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

integer (int64)

reasonsComplete
optional

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

boolean

researchCloseDate
optional

The Research Close Date of the downtime record.

string (date-time)

researchCommentsThreadId
optional

The Research Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

researchOpenDate
optional

The Research Open Date of the downtime record.

string (date-time)

researchStatus
optional

The Research Status of the downtime record.

IdNameValue

researchUser
optional

The Research User of the downtime record.

IdNameValue

startTime
optional

The Start Time of the downtime record

string (date-time)

status
optional

The Status of the downtime record

IdNameValue

uptime
optional

The Up Time of the downtime record

number (double)

user
optional

The User who entered the downtime record.

IdNameValue

3.5. DowntimeDurationFilter

Name Description Schema

maxDuration
optional

The maximum duration to be included in the filtered results

number (double)

minDuration
optional

The minimum duration to be included in the filtered results

number (double)

3.6. DowntimeLocation

Name Description Schema

asset
optional

The Asset (Unit) that identifies this location

BaseAssetInfo

department
optional

The Department this location belongs to

BaseAssetInfo

line
optional

The Line this location belongs to

BaseAssetInfo

3.7. DowntimePage

Name Schema

content
optional

< Downtime > array

links
optional

< Link > array

page
optional

PageMetadata

3.8. DowntimeRecord

Name Description Schema

action1
optional

The Level 1 Action of the downtime record.

TreeNodeInfo

action2
optional

The Level 2 Action of the downtime record.

TreeNodeInfo

action3
optional

The Level 3 Action of the downtime record.

TreeNodeInfo

action4
optional

The Level 4 Action of the downtime record.

TreeNodeInfo

actionCommentsThreadId
optional

The Action Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

asset
optional

The Asset(Unit) of the downtime record

BaseAssetInfo

category
optional

The Category of the downtime record

IdNameValue

cause1
optional

The Level 1 Cause (Reason) of the downtime record.

TreeNodeInfo

cause2
optional

The Level 2 Cause (Reason) of the downtime record.

TreeNodeInfo

cause3
optional

The Level 3 Cause (Reason) of the downtime record.

TreeNodeInfo

cause4
optional

The Level 4 Cause (Reason) of the downtime record.

TreeNodeInfo

causeCommentsThreadId
optional

The Cause Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

department
optional

The Department of the downtime record

BaseAssetInfo

downtimeId
optional

The Unique Id of the downtime record

integer (int64)

duration
optional

The Duration of the downtime record

number (double)

endTime
optional

The End Time of the downtime record

string (date-time)

esignatureId
optional

The E-Signature Id of the downtime record. Points to a Electronic signature record.

integer (int64)

eventStatus
optional

The Event Status of the downtime record

IdNameValue

fault
optional

The Fault of the downtime record

IdNameValue

line
optional

The Line of the downtime record

BaseAssetInfo

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)

reasonTreeDataId
optional

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

integer (int64)

reasonsComplete
optional

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

boolean

researchCloseDate
optional

The Research Close Date of the downtime record.

string (date-time)

researchCommentsThreadId
optional

The Research Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

researchOpenDate
optional

The Research Open Date of the downtime record.

string (date-time)

researchStatus
optional

The Research Status of the downtime record.

IdNameValue

researchUser
optional

The Research User of the downtime record.

IdNameValue

startTime
optional

The Start Time of the downtime record

string (date-time)

status
optional

The Status of the downtime record

IdNameValue

uptime
optional

The Up Time of the downtime record

number (double)

user
optional

The User who entered the downtime record.

IdNameValue

3.9. DowntimeRecords

Name Description Schema

downtimeRecords
optional

The list of downtime records

< DowntimeRecord > array

3.10. DowntimeResource

Name Description Schema

action1
optional

The Level 1 Action of the downtime record.

TreeNodeInfo

action2
optional

The Level 2 Action of the downtime record.

TreeNodeInfo

action3
optional

The Level 3 Action of the downtime record.

TreeNodeInfo

action4
optional

The Level 4 Action of the downtime record.

TreeNodeInfo

actionCommentsThreadId
optional

The Action Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

asset
optional

The Asset(Unit) of the downtime record

BaseAssetInfo

category
optional

The Category of the downtime record

IdNameValue

cause1
optional

The Level 1 Cause (Reason) of the downtime record.

TreeNodeInfo

cause2
optional

The Level 2 Cause (Reason) of the downtime record.

TreeNodeInfo

cause3
optional

The Level 3 Cause (Reason) of the downtime record.

TreeNodeInfo

cause4
optional

The Level 4 Cause (Reason) of the downtime record.

TreeNodeInfo

causeCommentsThreadId
optional

The Cause Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

department
optional

The Department of the downtime record

BaseAssetInfo

downtimeId
optional

The Unique Id of the downtime record

integer (int64)

duration
optional

The Duration of the downtime record

number (double)

endTime
optional

The End Time of the downtime record

string (date-time)

esignatureId
optional

The E-Signature Id of the downtime record. Points to a Electronic signature record.

integer (int64)

eventStatus
optional

The Event Status of the downtime record

IdNameValue

fault
optional

The Fault of the downtime record

IdNameValue

line
optional

The Line of the downtime record

BaseAssetInfo

links
optional

< Link > array

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)

reasonTreeDataId
optional

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

integer (int64)

reasonsComplete
optional

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

boolean

researchCloseDate
optional

The Research Close Date of the downtime record.

string (date-time)

researchCommentsThreadId
optional

The Research Comments Thread Id of the downtime record. Points to a chain of comments.

integer (int64)

researchOpenDate
optional

The Research Open Date of the downtime record.

string (date-time)

researchStatus
optional

The Research Status of the downtime record.

IdNameValue

researchUser
optional

The Research User of the downtime record.

IdNameValue

startTime
optional

The Start Time of the downtime record

string (date-time)

status
optional

The Status of the downtime record

IdNameValue

uptime
optional

The Up Time of the downtime record

number (double)

user
optional

The User who entered the downtime record.

IdNameValue

3.11. DowntimeSummary

Name Description Schema

categories
optional

List of category statistics. This provides counts of records available by category.

< CategoryStatistics > array

downtimeRecords
optional

Paged list of downtime records that match the request criteria

DowntimePage

filterCategories
optional

The categories available to filter by

< IdNameValue > array

filterDuration
optional

The duration available to filter by

DowntimeDurationFilter

filterLocations
optional

The locations available to filter by

< DowntimeLocation > array

filterStatuses
optional

The statuses available to filter by

< IdNameValue > array

links
optional

< Link > array

3.12. DowntimeUnitPermissions

Name Schema

unitId
optional

integer (int64)

unitPermissions
optional

< Permission > array

3.13. Error

Name Schema

code
optional

string

details
optional

object

3.14. Fault

Name Description Schema

faultId
optional

The Unique Id of the fault

integer (int64)

links
optional

< Link > array

name
optional

The descriptive name of the fault

string

reason1
optional

Level 1 reason associated with this fault

IdNameValue

reason2
optional

Level 2 reason associated with this fault

IdNameValue

reason3
optional

Level 3 reason associated with this fault

IdNameValue

reason4
optional

Level 4 reason associated with this fault

IdNameValue

3.15. FaultPage

Name Schema

content
optional

< Fault > array

links
optional

< Link > array

page
optional

PageMetadata

3.16. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.17. IdNameValue

Name Description Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.18. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.19. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.20. Permission

Name Schema

permissionName
optional

string

permissionValue
optional

boolean

3.21. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.22. TreeNodeInfo

Name Description Schema

commentRequired
optional

Denotes if comment is required if this node is selected
Example : false

boolean

id
optional

The unique ID of the TreeNode

integer (int64)

treeNodeName
optional

The name of the Node

string

3.23. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

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

Type : oauth2
Flow : application
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. resource_owner

Type : oauth2
Flow : password
Token URL : https://localhost:8443/oauth/token

Name Description

default

Default oauth2 scope.