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.
2. Resources
2.1. Labor-record-controller
Labor Record Controller
2.1.1. Create Labor Record
POST /v1/laborRecords
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Body |
laborRecordAddInfo |
Details of the labor record to create |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
201 |
Created |
|
400 |
Bad Request |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.1.2. Get labor records
GET /v1/laborRecords
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
endTime |
endTime |
string |
|
Query |
laborTypeId |
laborTypeId |
integer (int64) |
|
Query |
page |
Minimum value 0 |
integer (int32) |
|
Query |
size |
Max value 2000 |
integer (int32) |
|
Query |
startTime |
startTime |
string |
|
Query |
userName |
userName |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Success |
|
400 |
Bad Request |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.1.3. Get a labor record by id
GET /v1/laborRecords/{laborRecordId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
laborRecordId |
Id of the labor record |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.1.4. Update labor record
PUT /v1/laborRecords/{laborRecordId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
laborRecordId |
Labor Record Id |
integer (int64) |
Body |
laborRecordUpdateInfo |
Update Labor Record |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Bad Request |
|
404 |
Not Found |
|
422 |
Unprocessable Entity |
|
500 |
Internal Server Error |
2.1.5. Delete a labor record
DELETE /v1/laborRecords/{laborRecordId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
laborRecordId |
Labor record Id to be deleted |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
204 |
No Content |
object |
404 |
Not Found |
|
500 |
Internal Server Error |
2.2. Labor-type-controller
Labor Type Controller
2.2.1. Get labor types
GET /v1/laborTypes
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Query |
name |
name |
string |
|
Query |
page |
Minimum value 0 |
integer (int32) |
|
Query |
size |
Max value 2000 |
integer (int32) |
|
2.2.2. Get a labor type by id
GET /v1/laborTypes/{LaborTypeId}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Path |
LaborTypeId |
Id of the labor type |
integer (int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Unauthorized |
|
404 |
Not Found |
|
500 |
Internal Server Error |
3. Definitions
3.1. Error
Error details.
| Name | Description | Schema |
|---|---|---|
code |
string |
|
details |
Details of the error. |
object |
3.2. HttpErrorResponse
Http Error response.
| Name | Description | Schema |
|---|---|---|
error |
Error details |
|
path |
URL at which error occured. |
string |
timestamp |
Timestamp at which error occured |
string |
3.3. LaborRecordAddInfo
Labor Record add data tranfer object
| Name | Description | Schema |
|---|---|---|
appliedTime |
applied time for the labor record |
integer (int64) |
endTime |
end time for the labor record |
string |
laborTypeId |
labor type id for the labor record |
integer (int64) |
reasonId |
reasonId for the labor record |
integer (int64) |
segmentActualId |
segment actual id of the labor record |
integer (int64) |
startTime |
start time for the labor record |
string |
userName |
user name for the labor record |
string |
3.4. LaborRecordInfo
Labor Record data tranfer object
| Name | Description | Schema |
|---|---|---|
appliedTime |
applied time for the labor record |
integer (int64) |
clockedTime |
Actual clockedTime of the operator |
integer (int64) |
createdBy |
created by for the labor record |
string |
createdOn |
created on date/time for the labor record |
string |
endTime |
end time for the labor record |
string |
id |
id of the labor record |
integer (int64) |
laborTypeId |
labor type id for the labor record |
integer (int64) |
modifiedBy |
modified by for the labor record |
string |
modifiedOn |
modified on date/time for the labor record |
string |
reasonId |
reasonId for the labor record |
integer (int64) |
segmentActualId |
segment actual id of the labor record |
integer (int64) |
startTime |
start time for the labor record |
string |
userName |
user name for the labor record |
string |
3.5. LaborRecordInfoResult
| Name | Description | Schema |
|---|---|---|
appliedTime |
applied time for the labor record |
integer (int64) |
clockedTime |
Actual clockedTime of the operator |
integer (int64) |
createdBy |
created by for the labor record |
string |
createdOn |
created on date/time for the labor record |
string |
endTime |
end time for the labor record |
string |
id |
id of the labor record |
integer (int64) |
laborTypeId |
labor type id for the labor record |
integer (int64) |
links |
< Link > array |
|
modifiedBy |
modified by for the labor record |
string |
modifiedOn |
modified on date/time for the labor record |
string |
reasonId |
reasonId for the labor record |
integer (int64) |
segmentActualId |
segment actual id of the labor record |
integer (int64) |
startTime |
start time for the labor record |
string |
userName |
user name for the labor record |
string |
3.6. LaborRecordInfoResults
| Name | Schema |
|---|---|
content |
< Resource«LaborRecordInfo» > array |
links |
< Link > array |
page |
3.7. LaborRecordUpdateInfo
Labor Record update data tranfer object
| Name | Description | Schema |
|---|---|---|
appliedTime |
applied time for the labor record |
integer (int64) |
3.8. LaborTypeInfo
Labor type data tranfer object
| Name | Description | Schema |
|---|---|---|
createdBy |
created by for the labor type |
string |
createdOn |
created on date/time for the labor type |
string |
id |
id of the labor type |
integer (int64) |
name |
name for the labor type |
string |
3.9. LaborTypeInfoResult
| Name | Description | Schema |
|---|---|---|
createdBy |
created by for the labor type |
string |
createdOn |
created on date/time for the labor type |
string |
id |
id of the labor type |
integer (int64) |
links |
< Link > array |
|
name |
name for the labor type |
string |
3.10. LaborTypeInfoResults
| Name | Schema |
|---|---|
content |
< Resource«LaborTypeInfo» > array |
links |
< Link > array |
page |
3.12. PageMetadata
| Name | Schema |
|---|---|
number |
integer (int64) |
size |
integer (int64) |
totalElements |
integer (int64) |
totalPages |
integer (int64) |
3.13. Resource«LaborRecordInfo»
| Name | Description | Schema |
|---|---|---|
appliedTime |
applied time for the labor record |
integer (int64) |
clockedTime |
Actual clockedTime of the operator |
integer (int64) |
createdBy |
created by for the labor record |
string |
createdOn |
created on date/time for the labor record |
string |
endTime |
end time for the labor record |
string |
id |
id of the labor record |
integer (int64) |
laborTypeId |
labor type id for the labor record |
integer (int64) |
links |
< Link > array |
|
modifiedBy |
modified by for the labor record |
string |
modifiedOn |
modified on date/time for the labor record |
string |
reasonId |
reasonId for the labor record |
integer (int64) |
segmentActualId |
segment actual id of the labor record |
integer (int64) |
startTime |
start time for the labor record |
string |
userName |
user name for the labor record |
string |
3.14. Resource«LaborTypeInfo»
| Name | Description | Schema |
|---|---|---|
createdBy |
created by for the labor type |
string |
createdOn |
created on date/time for the labor type |
string |
id |
id of the labor type |
integer (int64) |
links |
< Link > array |
|
name |
name for the labor type |
string |
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. |