1. Overview

Microservice containing the business logic for managing labor-service.

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

  • labor-code-details-controller : Labor Code Details Controller

  • labor-planning-type-controller : Labor Planning Type Controller

  • labor-record-controller : Labor Record Controller

  • labor-type-controller : Labor Type Controller

2. Resources

2.1. Labor-code-details-controller

Labor Code Details Controller

2.1.1. Create Labor code

POST /v1/laborCodeDetails/create
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

laborCodeInfo
required

Details of the labor code to create

LaborCodeCreateRequest
Responses
HTTP Code Description Schema

201

Created

LaborCodeInfo

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.2. Get labor codes by unit, line and department

GET /v1/laborCodeDetails/getLaborCodes
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

includeAll
optional

If flag is set to true it retrieves all labor codes else it retrieves only global labor codes.

boolean

"false"

Query

lineId
optional

lineId

integer (int32)

Query

unitId
optional

unitId

string
Responses
HTTP Code Description Schema

200

OK

< LaborCodeInfo > array

401

Unauthorized

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.3. Get labor code by id

GET /v1/laborCodeDetails/getLaborCodesByIds
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

laborCodeId
required

laborCodeId

< integer (int32) > array(multi)
Responses
HTTP Code Description Schema

200

OK

< LaborCodeInfo > array

401

Unauthorized

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.1.4. Update Labor code

PUT /v1/laborCodeDetails/update/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int32)

Body

laborCodeInfo
required

Details of the labor code to update

LaborCodeUpdateRequest
Responses
HTTP Code Description Schema

201

Updated

LaborCodeInfo

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Labor-planning-type-controller

Labor Planning Type Controller

2.2.1. Get all labor planning types

GET /v1/laborPlanningTypes
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

page
optional

Minimum value 0

integer (int32)

0

Query

size
optional

Max value 2000

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

LaborPlanningTypeInfoResults

401

Unauthorized

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Labor-record-controller

Labor Record Controller

2.3.1. Create Labor Record

POST /v1/laborRecords
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

laborRecordAddInfo
required

Details of the labor record to create

LaborRecordAddInfo
Responses
HTTP Code Description Schema

201

Created

LaborRecordInfo

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. Get labor records

GET /v1/laborRecords
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

endTime
optional

endTime

string

Query

laborTypeId
optional

laborTypeId

integer (int64)

Query

page
optional

Minimum value 0

integer (int32)

0

Query

size
optional

Max value 2000

integer (int32)

20

Query

startTime
optional

startTime

string

Query

userName
optional

userName

string
Responses
HTTP Code Description Schema

200

Success

LaborRecordInfoResults

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.3. Get a labor record by id

GET /v1/laborRecords/{laborRecordId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

laborRecordId
required

Id of the labor record

integer (int64)
Responses
HTTP Code Description Schema

200

OK

LaborRecordInfoResult

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.4. Update labor record

PUT /v1/laborRecords/{laborRecordId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

laborRecordId
required

Labor Record Id

integer (int64)

Body

laborRecordUpdateInfo
required

Update Labor Record

LaborRecordUpdateInfo
Responses
HTTP Code Description Schema

200

OK

LaborRecordInfo

400

Bad Request

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.5. Delete a labor record

DELETE /v1/laborRecords/{laborRecordId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

laborRecordId
required

Labor record Id to be deleted

integer (int64)
Responses
HTTP Code Description Schema

204

No Content

object

404

Not Found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Labor-type-controller

Labor Type Controller

2.4.1. Create Labor Type

POST /v1/laborTypes
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

laborTypeRequest
required

Details of the labor type to create

LaborTypeRequest
Responses
HTTP Code Description Schema

201

Created

LaborTypeInfo

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.2. Get labor types

GET /v1/laborTypes
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

name
optional

name

string

Query

page
optional

Minimum value 0

integer (int32)

0

Query

size
optional

Max value 2000

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

LaborTypeInfoResults

401

Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.3. Get a labor type by id

GET /v1/laborTypes/{LaborTypeId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

LaborTypeId
required

Id of the labor type

integer (int64)
Responses
HTTP Code Description Schema

200

OK

LaborTypeInfoResult

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.4. Update Labor Type

PUT /v1/laborTypes/{laborTypeId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

laborTypeId
required

Labor Type Id

integer (int64)

Body

laborTypeRequest
required

Details of the labor type to update

LaborTypeRequest
Responses
HTTP Code Description Schema

200

Updated

LaborTypeInfo

400

Bad Request

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

3. Definitions

3.1. EntityModel«LaborPlanningTypeInfo»

Name Description Schema

createdBy
optional

created by for the labor planning type

string

createdOn
optional

created on date/time for the labor planning type

string (date-time)

id
optional

id of the labor planning type

integer (int64)

links
optional

< Link > array

name
optional

name for the labor planning type

string

3.2. EntityModel«LaborRecordInfo»

Name Description Schema

appliedTime
optional

applied time for the labor record

integer (int64)

clockedTime
optional

Actual clockedTime of the operator

integer (int64)

createdBy
optional

created by for the labor record

string

createdOn
optional

created on date/time for the labor record

string

endTime
optional

end time for the labor record

string

id
optional

id of the labor record

integer (int64)

laborTypeId
optional

labor type id for the labor record

integer (int64)

links
optional

< Link > array

modifiedBy
optional

modified by for the labor record

string

modifiedOn
optional

modified on date/time for the labor record

string

reasonId
optional

reasonId for the labor record

integer (int64)

segmentActualId
optional

segment actual id of the labor record

integer (int64)

startTime
optional

start time for the labor record

string

userName
optional

user name for the labor record

string

3.3. EntityModel«LaborTypeInfo»

Name Description Schema

createdBy
optional

created by for the labor type

string

createdOn
optional

created on date/time for the labor type

string

id
optional

id of the labor type

integer (int64)

laborPlanningTypeId
optional

labor planning type Id

integer (int64)

links
optional

< Link > array

modifiedBy
optional

modified by for the labor type

string

modifiedOn
optional

modified on date/time for the labor type

string

name
optional

name for the labor type

string

3.4. Error

Error details.

Name Description Schema

code
optional

string

details
optional

Details of the error.

object

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

Name Schema

appliesToMachine
optional

boolean

appliesToPeople
optional

boolean

deptId
optional

integer (int32)

displayName
optional

string

externalId
optional

string

inspectionFactor
optional

number (float)

lineId
optional

integer (int32)

runFactor
optional

number (float)

setupFactor
optional

number (float)

transportFactor
optional

number (float)

unitId
optional

integer (int32)

3.7. LaborCodeInfo

Name Schema

appliesToMachine
optional

boolean

appliesToPeople
optional

boolean

deptId
optional

integer (int32)

displayName
optional

string

externalId
optional

string

id
optional

integer (int32)

inspectionFactor
optional

number (float)

levelType
optional

string

lineId
optional

integer (int32)

runFactor
optional

number (float)

setupFactor
optional

number (float)

transportFactor
optional

number (float)

unitId
optional

integer (int32)

3.8. LaborCodeUpdateRequest

Name Schema

displayName
optional

string

externalId
optional

string

inspectionFactor
optional

number (float)

runFactor
optional

number (float)

setupFactor
optional

number (float)

transportFactor
optional

number (float)

3.9. LaborPlanningTypeInfo

Labor Planning type data tranfer object

Name Description Schema

createdBy
optional

created by for the labor planning type

string

createdOn
optional

created on date/time for the labor planning type

string (date-time)

id
optional

id of the labor planning type

integer (int64)

name
optional

name for the labor planning type

string

3.10. LaborPlanningTypeInfoResults

Name Schema

content
optional

< EntityModel«LaborPlanningTypeInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.11. LaborRecordAddInfo

Labor Record add data tranfer object

Name Description Schema

appliedTime
optional

applied time for the labor record

integer (int64)

endTime
optional

end time for the labor record

string

laborTypeId
required

labor type id for the labor record

integer (int64)

reasonId
required

reasonId for the labor record

integer (int64)

segmentActualId
required

segment actual id of the labor record

integer (int64)

startTime
required

start time for the labor record

string

userName
required

user name for the labor record

string

3.12. LaborRecordInfo

Labor Record data tranfer object

Name Description Schema

appliedTime
optional

applied time for the labor record

integer (int64)

clockedTime
optional

Actual clockedTime of the operator

integer (int64)

createdBy
optional

created by for the labor record

string

createdOn
optional

created on date/time for the labor record

string

endTime
optional

end time for the labor record

string

id
optional

id of the labor record

integer (int64)

laborTypeId
optional

labor type id for the labor record

integer (int64)

modifiedBy
optional

modified by for the labor record

string

modifiedOn
optional

modified on date/time for the labor record

string

reasonId
optional

reasonId for the labor record

integer (int64)

segmentActualId
optional

segment actual id of the labor record

integer (int64)

startTime
optional

start time for the labor record

string

userName
optional

user name for the labor record

string

3.13. LaborRecordInfoResult

Name Description Schema

appliedTime
optional

applied time for the labor record

integer (int64)

clockedTime
optional

Actual clockedTime of the operator

integer (int64)

createdBy
optional

created by for the labor record

string

createdOn
optional

created on date/time for the labor record

string

endTime
optional

end time for the labor record

string

id
optional

id of the labor record

integer (int64)

laborTypeId
optional

labor type id for the labor record

integer (int64)

links
optional

< Link > array

modifiedBy
optional

modified by for the labor record

string

modifiedOn
optional

modified on date/time for the labor record

string

reasonId
optional

reasonId for the labor record

integer (int64)

segmentActualId
optional

segment actual id of the labor record

integer (int64)

startTime
optional

start time for the labor record

string

userName
optional

user name for the labor record

string

3.14. LaborRecordInfoResults

Name Schema

content
optional

< EntityModel«LaborRecordInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.15. LaborRecordUpdateInfo

Labor Record update data tranfer object

Name Description Schema

appliedTime
required

applied time for the labor record

integer (int64)

3.16. LaborTypeInfo

Labor type data tranfer object

Name Description Schema

createdBy
optional

created by for the labor type

string

createdOn
optional

created on date/time for the labor type

string

id
optional

id of the labor type

integer (int64)

laborPlanningTypeId
optional

labor planning type Id

integer (int64)

modifiedBy
optional

modified by for the labor type

string

modifiedOn
optional

modified on date/time for the labor type

string

name
optional

name for the labor type

string

3.17. LaborTypeInfoResult

Name Description Schema

createdBy
optional

created by for the labor type

string

createdOn
optional

created on date/time for the labor type

string

id
optional

id of the labor type

integer (int64)

laborPlanningTypeId
optional

labor planning type Id

integer (int64)

links
optional

< Link > array

modifiedBy
optional

modified by for the labor type

string

modifiedOn
optional

modified on date/time for the labor type

string

name
optional

name for the labor type

string

3.18. LaborTypeInfoResults

Name Schema

content
optional

< EntityModel«LaborTypeInfo» > array

links
optional

< Link > array

page
optional

PageMetadata

3.19. LaborTypeRequest

Labor type data tranfer object

Name Description Schema

laborPlanningTypeId
optional

labor planning type id

integer (int64)

name
optional

name for the labor type

string

3.20. 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.21. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.22. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

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/uaa/oauth/authorize
Token URL : https://localhost/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.