1. Overview

The service contains a collection of RESTful service calls relating to Process Order from the Plant apps serverDescriptions 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

  • my-machines-controller : My Machines Controller

2. Resources

2.1. My-machines-controller

My Machines Controller

2.1.1. getMyMachinesEditorState

GET /mymachines-viewer
Parameters
Type Name Description Schema Default

Query

eventId
optional

eventId

integer (int64)

2

Query

expandLines
optional

expandLines

boolean

"true"

Query

expandUnits
optional

expandUnits

boolean

"true"

Query

previousPreferences
optional

previousPreferences

integer (int32)

0
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.1.2. getmymachineEditorStateLines

GET /mymachines-viewer/departments/{deptId}/lines
Parameters
Type Name Description Schema

Path

deptId
required

deptId

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.1.3. getmymachineEditorStateUnits

GET /mymachines-viewer/lines/{lineId}/units
Parameters
Type Name Description Schema

Path

lineId
required

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.1.4. updatePreferences

POST /mymachines-viewer/preferences
Parameters
Type Name Description Schema

Body

preferredMachinesUpdates
required

preferredMachinesUpdates

PreferredMachinesDTO
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

3. Definitions

3.1. PreferredMachinesDTO

Name Schema

units
optional

< PreferredMachinesInfo > array

userId
optional

integer (int64)

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