1. Overview

Core for Operator Log Application

1.1. License information

License : Copyright (c) 2020 GE. All Rights Reserved. GE Confidential: Restricted Internal Distribution
License URL : https://github.build.ge.com/plantapps/operator-log-service
Terms of service : null

1.2. URI scheme

Host : localhost:39988
BasePath : /

1.3. Tags

  • operator-log-controller : Operator Log Controller

2. Resources

2.1. Operator-log-controller

Operator Log Controller

2.1.1. Creates a new event

POST /v1/operatorLogEvents/events
Parameters
Type Name Description Schema

Body

eventRecord
required

Log EventRecord object to add a new event

OperatorLogEventCreate
Responses
HTTP Code Description Schema

201

Created

OperatorLogEvent

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Fetches Events

GET /v1/operatorLogEvents/events
Parameters
Type Name Description Schema

Query

assignTo
optional

assign to

string

Query

endTime
optional

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

string (date-time)

Query

eventType
optional

eventType

enum (LogEntries, Incidents, HandOffs)

Query

line
optional

List of Line Id’s, Can also set comma seperated Line ids

string

Query

startTime
optional

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

string (date-time)

Query

status
optional

status

enum (Open, InProgress, Closed)

Query

timeSelection
required

timeSelection

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

Query

unit
optional

List of Unit Ids, Can also set comma seperated unit ids for this property

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Requested Resource Not Found

No Content

500

Internal Server Error

No Content
Produces

  • 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. Fetches Events

GET /v1/operatorLogEvents/id
Parameters
Type Name Description Schema

Query

Id
required

Log detail Id

integer (int32)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Requested Resource Not Found

No Content

500

Internal Server Error

No Content
Produces

  • 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. fetches the timeselect

GET /v1/operatorLogEvents/timeSelection
Parameters
Type Name Description Schema

Query

endTime
optional

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

string (date-time)

Query

startTime
optional

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

string (date-time)

Query

timeSelection
required

timeSelection

enum (CurrentDay, PreviousDay, CurrentWeek, PreviousWeek, NextWeek, NextDay, Custom, CurrentShift, PreviousShift, NextShift)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content
Produces

  • 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.5. updating the status

PUT /v1/operatorLogEvents/updateStatus
Parameters
Type Name Description Schema

Body

eventRecord
required

Log EventRecord Object to update the status

OperateLogEventUpdate
Responses
HTTP Code Description Schema

201

Created

BaseResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • 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. BaseResponse

Name Schema

data
optional

object

links
optional

< Link > array

message
optional

string

statusCode
optional

integer (int32)

3.2. Error

Name Schema

code
optional

string

details
optional

object

3.3. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.4. IdNameValue

Name Description Schema

id
optional

The unique ID of the entity

integer (int64)

name
optional

The name of the entity

string

3.5. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.6. OperateLogEventUpdate

Name Description Schema

logDetailId
optional

Log DetailsId defines the logtypeID

integer (int64)

statusId
optional

status of the log event

integer (int64)

3.7. OperatorLogEvent

Name Description Schema

assignedTo
optional

assigned user of the log event

IdNameValue

cause1
optional

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

IdNameValue

cause2
optional

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

IdNameValue

cause3
optional

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

IdNameValue

cause4
optional

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

IdNameValue

comment
optional

comment id of the log event

IdNameValue

endTime
optional

The end time of the log event

string (date-time)

entryOn
optional

The entry on time of the log event

string (date-time)

line
optional

productionLineId of Log Event

IdNameValue

linkedEvents
optional

Linked events

object

logDetailId
optional

Unique identifier of this Log Event record

integer (int64)

logType
optional

Log Type defines the type of Log Event

IdNameValue

sourceProductionUnitId
optional

sourceProductionUnitId od Log Event

integer (int64)

startTime
optional

The start time of the log event starts

string (date-time)

statusId
optional

status of the log event

IdNameValue

summary
optional

summary of the log event

string

unit
optional

productionUnitId of Log Event

IdNameValue

user
optional

The user defines the log creator of Event Record.

IdNameValue

3.8. OperatorLogEventCreate

Name Description Schema

assignedTo
optional

assigned user of the log event

integer (int64)

lineId
optional

lineId

integer (int64)

linkedEvents
optional

Linked events

object

logType
optional

Log Type defines the type of Log Event

integer (int64)

statusId
optional

status of the log event

integer (int64)

summary
optional

summary of the log event

string

unitId
optional

productionUnitId of Log Event

integer (int64)

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : https://hostname/uaa/oauth/authorize
Token URL : https://hostname/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://hostname/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://hostname/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://hostname/uaa/oauth/token

Name Description

default

Default oauth2 scope.