1. Overview

Microservice containing the core business logic for assignment-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • assignment-controller : Assignment Controller

2. Resources

2.1. Assignment-controller

Assignment Controller

2.1.1. Assign Operations to operator

POST /assignments
Parameters
Type Name Description Schema

Body

assignOperationDTOs
required

assignOperationDTOs

< AssignOperationDTO > array
Responses
HTTP Code Description Schema

200

OK

AssignedOperationsResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

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.2. Get assignments of all operators or by operator name or workOrderId or segmentId

GET /assignments
Parameters
Type Name Description Schema Default

Query

byOperation
optional

byOperation

boolean

Query

operatorName
optional

operatorName

string

Query

page
optional

page

integer (int32)

0

Query

segmentActualId
optional

segmentActualId

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

size
optional

size

integer (int32)

20

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssignedOperationResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
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. Delete Assign Operations to operator

DELETE /assignments
Parameters
Type Name Description Schema

Body

assignOperationDTOs
required

assignOperationDTOs

< AssignOperationDTO > array
Responses
HTTP Code Description Schema

200

OK

AssignedOperationResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
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. ClockOff SegementActual Operation to operator

DELETE /assignments/clockOff
Parameters
Type Name Description Schema

Query

checkOperationComplete
optional

checkOperationComplete

boolean

Body

assignedOperationDTOs
required

assignedOperationDTOs

< AssignedOperationsDetailsDTO > array
Responses
HTTP Code Description Schema

200

OK

AssignedOperation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
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.5. ClockOn SegementActual Operation to operator

POST /assignments/clockOn
Parameters
Type Name Description Schema

Body

assignedOperationDTOs
required

assignedOperationDTOs

< AssignedOperationsDetailsDTO > array
Responses
HTTP Code Description Schema

200

OK

object

201

CREATED

AssignedOperation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

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

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.6. Get Assigned Operation by Id

GET /assignments/{assignmentId}
Parameters
Type Name Description Schema

Path

assignmentId
required

assignmentId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

AssignedOperation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
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.7. Update Assigned Operation by Id

PUT /assignments/{assignmentId}
Parameters
Type Name Description Schema

Path

assignmentId
required

assignmentId

integer (int64)

Body

assignedOperationDTO
required

assignedOperationDTO

AssignOperationDTO
Responses
HTTP Code Description Schema

200

OK

AssignedOperation

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

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.8. Delete Assigned Operation by Id

DELETE /assignments/{assignmentId}
Parameters
Type Name Description Schema

Path

assignmentId
required

assignmentId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. AppliesTo

Name Schema

materialLotActualIds
optional

< integer (int64) > array

3.2. AssignOperationDTO

Name Schema

assignedBy
optional

string

assignedTo
optional

string

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.3. AssignedOperation

Name Schema

assignedBy
optional

string

assignedOn
optional

string

assignedOperationId
optional

integer (int64)

assignedTo
optional

string

createdOn
optional

string

id
optional

integer (int64)

lastModifiedOn
optional

string

materialLotActualId
optional

integer (int64)

segmentActualId
optional

integer (int64)

segmentDefinitionInfo
optional

SegmentDefinitionInfo

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.4. AssignedOperationResource

Name Schema

assignedBy
optional

string

assignedOn
optional

string

assignedOperationId
optional

integer (int64)

assignedTo
optional

string

createdOn
optional

string

id
optional

integer (int64)

lastModifiedOn
optional

string

links
optional

< Link > array

materialLotActualId
optional

integer (int64)

segmentActualId
optional

integer (int64)

segmentDefinitionInfo
optional

SegmentDefinitionInfo

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.5. AssignedOperationResponse

Name Schema

content
optional

AssignedOperation

message
optional

string

3.6. AssignedOperationResults

Name Schema

content
optional

< AssignedOperationResource > array

links
optional

< Link > array

page
optional

PageMetadata

3.7. AssignedOperationsDetailsDTO

Name Schema

assignedBy
optional

string

assignedTo
optional

string

segmentActualId
optional

integer (int64)

segmentDefinitionInfo
optional

SegmentDefinitionInfo

segmentId
optional

integer (int64)

workOrderId
optional

integer (int64)

3.8. AssignedOperationsResponse

Name Schema

content
optional

< AssignedOperation > array

message
optional

string

3.9. Error

Name Schema

code
optional

integer (int32)

details
optional

object

3.10. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.11. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.12. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.13. SegmentDefinitionInfo

Name Schema

appliesTo
optional

AppliesTo

operationDescription
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.