1. Overview

Microservice containing the business logic for managing work-order-history.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • history-controller : History Controller

2. Resources

2.1. History-controller

History Controller

2.1.1. Get History Events

GET /historyEntries/{workOrderId}
Parameters
Type Name Description Schema

Path

workOrderId
required

WorkOrder Id

integer (int64)

Query

materialLotActualId
optional

MaterialLotActualId

integer (int64)

Query

page
optional

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

integer (int32)

Query

segmentActualId
optional

SegmentActualId

integer (int64)

Query

segmentId
optional

SegmentId

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

HistoryEventPage

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse
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. Error

Error details.

Name Description Schema

code
optional

string

details
optional

Details of the error.

object

3.2. HistoryEntryDataInfo

Name Schema

newValue
optional

string

oldValue
optional

string

order
optional

string

propertyName
optional

string

propertyType
optional

string

3.3. HistoryEventInfo

History Event data transfer object

Name Description Schema

currentLotIdentifier
optional

Name of the material lot

string

entryData
optional

< HistoryEntryDataInfo > array

entryType
optional

Name of the source event

string

id
optional

Unique Id of the History Event Record

integer (int64)

materialLotActualId
optional

Id of the material lot

integer (int64)

performedBy
optional

Name of the user who generated the event

string

producedMaterialCode
optional

Code of the Produced Material by WorkOrder

string

producedMaterialDescription
optional

Description of the Produced Material by WorkOrder

string

productionLineId
optional

Work order production line ID

integer (int64)

productionLineName
optional

Work order production line name

string

segmentActualId
optional

Id of the segment actual

integer (int64)

segmentId
optional

Id of the segment that is being tracked

integer (int64)

segmentName
optional

Name of the segment that is being tracked

string

sourceEventId
optional

Id of the source event

integer (int64)

timestamp
optional

Time of generation of event

string (date-time)

workOrderId
optional

Id of the workorder for which the event is generated

integer (int64)

workOrderName
optional

Name of the workorder for which the event is generated

string

3.4. HistoryEventPage

Name Schema

content
optional

< HistoryEventInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.5. HttpErrorResponse

Http Error response.

Name Description Schema

error
optional

Error details

Error

path
optional

URL at which error occured.

string

timestamp
optional

Timestamp at which error occured

string

3.6. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.7. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : http://localhost:8443/uaa/oauth/authorize
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : http://localhost:8443/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : http://localhost:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.