1. Overview

Microservice containing the business logic for managing mymachineservice.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • my-machines-controller : My Machines Controller

  • my-machines-dept-controller : My Machines Dept Controller

  • my-machines-line-controller : My Machines Line Controller

  • my-machines-unit-controller : My Machines Unit Controller

2. Resources

2.1. My-machines-controller

My Machines Controller

2.1.1. updateUserPreferences

POST /myMachines/v1/preferences
Parameters
Type Name Description Schema

Body

preferredMachines
required

preferredMachines

PreferredMachines
Responses
HTTP Code Description Schema

200

OK

object
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.2. My-machines-dept-controller

My Machines Dept Controller

2.2.1. getDepts

GET /myMachines/v1/departments/authorized-depts
Parameters
Type Name Description Schema Default

Query

expandLines
optional

expandLines

boolean

"false"

Query

expandUnits
optional

expandUnits

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object
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.2.2. getPreferredDepts

GET /myMachines/v1/departments/preferred-depts
Parameters
Type Name Description Schema Default

Query

expandLines
optional

expandLines

boolean

"false"

Query

expandUnits
optional

expandUnits

boolean

"false"

Query

previousPreferences
optional

previousPreferences

integer (int32)

0

Query

retrieveChildren
optional

retrieveChildren

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object
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.3. My-machines-line-controller

My Machines Line Controller

2.3.1. getLines

GET /myMachines/v1/lines/authorized-lines
Parameters
Type Name Description Schema Default

Query

departmentId
optional

departmentId

integer (int64)

Query

expandUnits
optional

expandUnits

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object
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.3.2. getPreferredLines

GET /myMachines/v1/lines/preferred-lines
Parameters
Type Name Description Schema Default

Query

departmentId
optional

departmentId

integer (int64)

Query

expandUnits
optional

expandUnits

boolean

"false"

Query

previousPreferences
optional

previousPreferences

integer (int32)

0

Query

retrieveChildren
optional

retrieveChildren

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object
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.4. My-machines-unit-controller

My Machines Unit Controller

2.4.1. getUnits

GET /myMachines/v1/units/authorized-units
Parameters
Type Name Description Schema

Query

lineId
optional

lineId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object
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.4.2. getPreferredUnits

GET /myMachines/v1/units/preferred-units
Parameters
Type Name Description Schema Default

Query

lineId
optional

lineId

integer (int64)

Query

previousPreferences
optional

previousPreferences

integer (int32)

0

Query

retrieveChildren
optional

retrieveChildren

boolean

"false"
Responses
HTTP Code Description Schema

200

OK

object
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

3. Definitions

3.1. BaseAssetInfo

Name Schema

assetId
optional

integer (int64)

name
optional

string

type
optional

enum (Department, Line, Unit, Group, Variable, ProcessOrder)

3.2. PreferredMachines

Name Schema

units
optional

< PreferredMachinesInfo > array

userId
optional

integer (int64)

3.3. PreferredMachinesInfo

Name Schema

eventId
optional

integer (int64)

id
optional

integer (int64)

transactiontype
optional

integer (int32)

unitName
optional

string

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.