1. Overview

Microservice containing the business logic for managing route-app-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 : /route-app-service/

1.2. Tags

  • bom-formulation-controller : Bom Formulation Controller

  • document-management-controller : Document Management Controller

  • labor-type-controller : Labor Type Controller

  • line-controller : Line Controller

  • permission-check-controller : Permission Check Controller

  • product-controller : Product Controller

  • property-group-controller : Property Group Controller

  • route-controller : Route Controller

  • segment-controller : Segment Controller

  • unit-controller : Unit Controller

  • user-settings-controller : User Settings Controller

  • work-order-controller : Work Order Controller

2. Resources

2.1. Bom-formulation-controller

Bom Formulation Controller

2.1.1. Get UnitOfMeasure details

GET /v1/routes-viewer/engineeringUnit/{uomId}
Parameters
Type Name Description Schema

Path

uomId
required

uomId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

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.2. Get BOM item by formulationItemId

GET /v1/routes-viewer/formulations/items/{formulationItemId}
Parameters
Type Name Description Schema

Path

formulationItemId
required

formulationItemId to get a BOM item

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

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.3. Get BOM items by formulationId

GET /v1/routes-viewer/formulations/{formulationId}/items
Parameters
Type Name Description Schema

Path

formulationId
required

formulationId to get a list of BOM items

integer (int64)

Query

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

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.4. Get BOM formulations

GET /v1/routes-viewer/products/{productId}/formulations
Parameters
Type Name Description Schema

Path

productId
required

productId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

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.2. Document-management-controller

Document Management Controller

2.2.1. Create Metadata / Create revision

POST /v1/routes-viewer/documents
Parameters
Type Name Description Schema

Query

clientId
required

clientId

string

Body

documentMetaInfo
required

Metadata for creation of document or revision

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.2.2. Get Documents

GET /v1/routes-viewer/documents
Parameters
Type Name Description Schema Default

Query

clientId
required

clientId

string

Query

documentId
optional

document id

string

Query

pageNo
optional

page

integer (int32)

0

Query

routeId
optional

route id

integer (int64)

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.2.3. document Upload

PUT /v1/routes-viewer/documents
Parameters
Type Name Description Schema

Query

attachmentName
optional

Attachment Name

string

Query

clientId
required

clientId

string

Query

docId
required

Document Id

string

Query

rev
required

Document Revision Id

string

FormData

file
required

Upload Document

file
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • multipart/form-data

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.4. Get document

GET /v1/routes-viewer/documents/attachment
Parameters
Type Name Description Schema

Query

attachmentName
optional

attachment Name(required if documentId is not null)

string

Query

clientId
required

clientId

string

Query

documentId
required

document id or url

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.5. Create document reference

POST /v1/routes-viewer/documents/references
Parameters
Type Name Description Schema

Query

clientId
required

clientId

string

Body

documentReference
required

Document reference

string
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.2.6. Get Revisions By InitialId

GET /v1/routes-viewer/documents/{initialId}
Parameters
Type Name Description Schema

Path

initialId
required

initial id

string

Query

clientId
required

clientId

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

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.3. Labor-type-controller

Labor Type Controller

2.3.1. Get LaborTypes

GET /v1/routes-viewer/laborTypes
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

HttpErrorResponse

503

Service Unavailable

Api error
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. Line-controller

Line Controller

2.4.1. Get all lines

GET /v1/routes-viewer/lines
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content
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. Get a single line

GET /v1/routes-viewer/lines/{lineId}
Parameters
Type Name Description Schema

Path

lineId
required

lineId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

404

Not Found

No Content
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.5. Permission-check-controller

Permission Check Controller

2.5.1. checkPermission

GET /v1/routes-viewer/checkPermission
Parameters
Type Name Description Schema

Query

permissionName
required

Permission Scope

string

Query

resourceId
required

UnitId or LineId

integer (int32)

Query

resourceType
required

Unit or Line

string
Responses
HTTP Code Description Schema

200

OK

boolean

401

Unauthorized

HttpErrorResponse

404

Not Found

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.6. Product-controller

Product Controller

2.6.1. Get Products

GET /v1/routes-viewer/products
Parameters
Type Name Description Schema

Query

lineId
optional

lineId

integer (int32)

Query

material
optional

material

string
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

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.7. Property-group-controller

Property Group Controller

2.7.1. Get all property definitions

GET /v1/properties/definitions
Parameters
Type Name Description Schema Default

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.2. Get all revisions for property-group-definition

GET /v1/properties/definitions/{initialId}/revisions
Parameters
Type Name Description Schema

Path

initialId
required

initialId

string
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.3. Get all property groups list

GET /v1/properties/groups
Parameters
Type Name Description Schema Default

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.4. Get all property group with definitions list

GET /v1/properties/groups-definitions
Parameters
Type Name Description Schema Default

Query

includeDeleted
optional

includeDeleted

boolean

"false"

Query

page
optional

page

integer (int32)

0

Query

size
optional

size

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.5. Get property group by property group id

GET /v1/properties/groups/{groupId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.6. Get selected list of property groups for route or segment

GET /v1/properties/routes/{routeId}/segments/{segmentId}
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Path

segmentId
required

segmentId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No selected group properties for the given request

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.7.7. Get all property definitions by property group id

GET /v1/properties/{groupId}/definitions
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8. Route-controller

Route Controller

2.8.1. Create Route

POST /v1/routes-viewer/routes
Parameters
Type Name Description Schema

Body

route
required

route

RouteForCreateInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8.2. Get routes

GET /v1/routes-viewer/routes
Parameters
Type Name Description Schema Default

Query

description
optional

description

string

Query

modifiedBY
optional

modifiedBY

string

Query

name
optional

name

string

Query

orderBy
optional

enum (asc, desc)

"desc"

Query

orderByColumn
optional

orderByColumn

string

"lastModifiedOn"

Query

page
optional

integer (int32)

0

Query

producedMaterialId
optional

producedMaterialId

integer (int64)

Query

productionLineId
optional

productionLineId

integer (int64)

Query

showAllRevision
optional

showAllRevision

boolean

"true"

Query

size
optional

integer (int32)

20

Query

status
optional

status

string
Responses
HTTP Code Description Schema

200

OK

object

401

ERR401: Unauthorized

No Content

500

ERR500: Internal Server Error

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.3. Get Secret Key

POST /v1/routes-viewer/routes/secretkey
Parameters
Type Name Description Schema

Body

route
required

route

RouteForCreateInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8.4. Get route

GET /v1/routes-viewer/routes/{routeId}
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8.5. Delete Route

DELETE /v1/routes-viewer/routes/{routeId}
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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

2.8.6. Update Route

PATCH /v1/routes-viewer/routes/{routeId}
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Body

routeInfo
required

routeInfo

RouteForUpdateInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8.7. Archive route

PATCH /v1/routes-viewer/routes/{routeId}/archive
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Body

routeForStatusUpdateInfo
required

routeForStatusUpdateInfo

RouteForStatusUpdateInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.8.8. Copy route

POST /v1/routes-viewer/routes/{routeId}/copy
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Body

routeInput
required

routeInput

RouteForCreateInfo
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Server error

No Content
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.8.9. Create a New Revision

POST /v1/routes-viewer/routes/{routeId}/revision
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Server error

No Content
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.8.10. Release Route

POST /v1/routes-viewer/routes/{routeId}/{confirmRelease}/release
Parameters
Type Name Description Schema Default

Path

confirmRelease
required

confirm release flag

boolean

"false"

Path

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Server error

No Content
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.8.11. Upgrade Segment

GET /v1/routes-viewer/upgrade/{schemaVersion}/{routeId}
Parameters
Type Name Description Schema

Path

routeId
required

RouteId of segment

integer (int64)

Path

schemaVersion
required

Schema Version

integer (int32)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.9. Segment-controller

Segment Controller

2.9.1. Get Segments

GET /v1/segments-viewer/{routeId}/segments
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.9.2. Add Segment

PUT /v1/segments-viewer/{routeId}/segments
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Body

segmentDefInput
required

segmentDefInput

SegmentsDefinitionInfo
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.9.3. Get Segment

GET /v1/segments-viewer/{routeId}/segments/{segmentId}
Parameters
Type Name Description Schema

Path

routeId
required

routeId

integer (int64)

Path

segmentId
required

segmentId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.10. Unit-controller

Unit Controller

2.10.1. Get all units

GET /v1/routes-viewer/units
Parameters
Type Name Description Schema

Query

lineId
optional

lineId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.11. User-settings-controller

User Settings Controller

2.11.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

Conflict, User Setting already exists. Use a PUT to update

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.11.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

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.11.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, There is no saved User settings for the logged in user

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.11.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

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.11.5. Get Privilege Sets

GET /v2/settings/apps
Parameters
Type Name Description Schema

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

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.12. Work-order-controller

Work Order Controller

2.12.1. Create work order

POST /v1/workOrders
Parameters
Type Name Description Schema

Body

workOrderCreation
required

workOrderCreation

WorkOrderCreationRequest
Responses
HTTP Code Description Schema

200

OK

object

201

Created

WorkOrder

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.12.2. update properties

PUT /v1/workOrders
Parameters
Type Name Description Schema

Body

workOrderPropertiesUpdateRequest
required

workOrderPropertiesUpdateRequest

WorkOrderPropertiesUpdateRequest
Responses
HTTP Code Description Schema

200

OK

object

201

Created

WorkOrder

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.12.3. Check work order

GET /v1/workOrders/exists
Parameters
Type Name Description Schema

Query

workOrderName
optional

workOrderName

string
Responses
HTTP Code Description Schema

200

Ok

WorkOrderExistsResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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.12.4. Delete work order

DELETE /v1/workOrders/{workOrderId}
Parameters
Type Name Description Schema

Path

workOrderId
required

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

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

3. Definitions

3.1. Api error

Http Error response.

Name Schema

errorCode
optional

string

message
optional

string

requestPath
optional

string

status
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

subErrors
optional

ApiSubError

timestamp
optional

string

3.2. ApiSubError

Name Schema

args
optional

< string > array

errorCode
optional

string

field
optional

string

message
optional

string

value
optional

object

3.3. BillOfMaterialInfo

Bill of Materials of a route.

Name Description Schema

behaviors
required

Behaviours of a BOM item

object

bomItemId
required

Bom Item Id of the material

integer (int32)

materialId
required

Id of the material

integer (int32)

propertyValues
optional

properties associated to a segment.

< PropertiesDefInfo > array

quantity
required

Quantity of the material

number (double)

unitOfMeasureId
required

Id of the unitOfMeasure

integer (int32)

visualization
required

Visualization of a BOM item

BillOfMaterialsVisualization

3.4. BillOfMaterialsVisualization

Behaviours for Bill of Material of a route.

Name Description Schema

displayOrder
required

BOM item requires displayOrder

integer (int32)

3.5. DocumentInfo

Documents of a route.

Name Description Schema

displayName
required

Name of the document

string

link
required

Link of the document

string

3.6. Error

Name Schema

code
optional

string

details
optional

object

3.7. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.8. Link

Holds a resource link to support HATEOAS

Name Description Schema

href
optional

URL for the link.

string

rel
optional

Type or relation of the link.

string

templated
optional

Indicates if the link uses templating.
Example : false

boolean

3.9. MaterialLotEntryRequest

Name Schema

lotIdentifier
optional

string

plannedQuantity
optional

integer (int32)

3.10. OperationsInfo

Operations of a route.

Name Description Schema

id
required

Id of the operation

integer (int64)

sequenceNumber
required

Sequence number of the operation

integer (int32)

3.11. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.12. PropertiesDefInfo

Properties of a route.

Name Description Schema

propertyDefinitionId
required

Id of property

string

propertyValue
required

Value of property

string

3.13. RouteForCreateInfo

Name Description Schema

bomFormulationId
optional

bomFormulationId of the route

integer (int64)

description
optional

description of the route record

string

name
optional

name of the route record

string

producedMaterialId
optional

producedMaterialId of the route record

integer (int64)

productionLineId
optional

productionLineId of the route record

integer (int64)

revision
optional

revision of the route record

integer (int32)

secretKey
optional

secretkey of the BFF request

string

status
optional

status of the route record

string

3.14. RouteForStatusUpdateInfo

Route data tranfer object for update

Name Description Schema

status
required

Status of the route record

string

3.15. RouteForUpdateInfo

Route data tranfer object for update

Name Description Schema

bomFormulationId
optional

bomFormulationId of the route record

integer (int64)

description
optional

Description of the route record

string

name
optional

Name of the route record

string

status
optional

Status of the route record

string

3.16. RouteSegmentInfo

RouteSegment data tranfer object

Name Description Schema

id
required

id of the route Segment

integer (int64)

3.17. SegmentInfo

Segment data tranfer object

Name Description Schema

appliesTo
required

Qualifiers for operations based on this segment.

SegmentsAppliesTo

behaviors
optional

Behaviors of a segment

< string > array

billOfMaterials
optional

Bill of materials associated to a segment.

< BillOfMaterialInfo > array

description
optional

Description of the segment.

string

documents
optional

documents associated to a segment.

< DocumentInfo > array

id
required

id of the route segment

integer (int64)

name
required

Name of the segment.

string

plannedUnitIds
optional

units associated to a segment.

< integer (int64) > array

propertyValues
optional

properties associated to a segment.

< PropertiesDefInfo > array

segmentType
required

Type of the segment. Possible options are Segment, Reference

string

suggestedLaborTypes
required

Labor types to expected on operations for this segment. First value is the default labor type.

< integer (int64) > array

3.18. SegmentsAppliesTo

Qualifiers for the segment definition.

Name Description Schema

materialLotActualIds
required

Material lot actual(s) that the segment applies to. Applies to all material lot actual(s) if empty.

< integer (int64) > array

3.19. SegmentsDefinitionInfo

Segment data tranfer object

Name Description Schema

plannedLineId
required

Line Id to which segment document belongs/refers to

integer (int64)

producedMaterialId
required

produced material Id

integer (int64)

schemaVersion
required

Version of the segments document.

integer (int32)

segments
required

List of segments

< SegmentInfo > array

structure
required

Structure of segments

StructureInfo

structureType
required

Structure Type of segment. Possible options are Simple, TreeHierarchy

string

3.20. StructureInfo

Name Description Schema

operations
required

List of operations

< OperationsInfo > array

routeSegment
required

Route segment details

RouteSegmentInfo

3.21. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} }
Example : {
"AppKey1" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey2" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey3" : {
"property1" : { },
"property2" : { },
"property3" : { }
}
}

object

viewName
optional

string

3.22. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.23. WorkOrder

Work order Data transfer object

Name Description Schema

cancelledOn
optional

Date that the work order was cancelled.

string (date-time)

completedOn
optional

Date that the work order was completed.

string (date-time)

createdBy
optional

User that created the route.

string

createdOn
optional

Date that the work order was created.

string (date-time)

eTagValue
optional

Current ETag value of the work order resource

string

id
optional

Work Order ID.

integer (int64)

lastModifiedBy
optional

User that last modified the route.

string

lastModifiedOn
optional

Date that the route was last modified.

string (date-time)

links
optional

Set of links on the resource.

< Link > array

name
optional

Work Order name.

string

plannedEndDate
optional

Planned end date for the work order.

string (date-time)

plannedQuantity
optional

The planned quantity to produce with this work order.

integer (int32)

plannedStartDate
optional

Planned start date for the work order.

string (date-time)

priority
optional

Relative priority of the work order.

integer (int32)

processOrderId
optional

Work order’s process order in the plant apps execution system.

integer (int64)

producedMaterialId
optional

Work order produced material ID.

integer (int64)

productionLineId
optional

Work order production line ID.

integer (int64)

readyOn
optional

Date that the work order was made ready.

string (date-time)

routeDefinitionId
optional

Refers to the route used to execute the work order.

integer (int64)

startedOn
optional

Date that the work order was started.

string (date-time)

status
optional

Status of the work order.

string

3.24. WorkOrderCreationRequest

Name Schema

materialLotEntries
optional

< MaterialLotEntryRequest > array

name
optional

string

plannedEndDate
optional

string (date-time)

plannedStartDate
optional

string (date-time)

priority
optional

integer (int32)

producedMaterialId
optional

integer (int64)

productionLineId
optional

integer (int64)

routeDefinitionId
optional

integer (int64)

3.25. WorkOrderExistsResponse

Name Schema

exists
optional

boolean

id
optional

integer (int64)

status
optional

string

3.26. WorkOrderProperties

WorkOrderProperties data tranfer object

Name Schema

propertiesDefInfoList
optional

< PropertiesDefInfo > array

segementDefinitionId
optional

integer (int64)

3.27. WorkOrderPropertiesUpdateRequest

WorkOrderPropertiesUpdateRequest data tranfer object

Name Schema

workOrderId
optional

integer (int64)

workOrderPropertiesList
optional

< WorkOrderProperties > array

4. Security

4.1. access_token

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

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.