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 : /

1.2. Tags

  • approval-workflow-event-controller : Approval Workflow Event Controller

  • bom-formulation-controller : Bom Formulation Controller

  • document-management-controller : Document Management Controller

  • event-sub-type-controller : Event Sub Type Controller

  • external-config-controller : External Config Controller

  • historian-controller : Historian Controller

  • labor-code-details-controller : Labor Code Details Controller

  • labor-type-controller : Labor Type Controller

  • line-controller : Line Controller

  • permission-check-controller : Permission Check Controller

  • product-controller : Product Controller

  • product-property-value-controller : Product Property Value Controller

  • property-group-controller : Property Group Controller

  • route-controller : Route Controller

  • segment-controller : Segment Controller

  • tool-category-controller : Tool Category Controller

  • tool-controller : Tool Controller

  • unit-controller : Unit Controller

  • user-settings-controller : User Settings Controller

  • variable-controller : Variable Controller

  • work-order-controller : Work Order Controller

2. Resources

2.1. Approval-workflow-event-controller

Approval Workflow Event Controller

2.1.1. Query WorkFlow Configurations by Event ID

GET /approval-workflow/v1/workflow-events/{id}/workflow-configurations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

Event Id

integer (int32)

Query

lineId
optional

Production Line Id

integer (int64)

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

0

Query

size
optional

Number of records per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

OK

WorkflowConfigurationInfosPage

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2. Bom-formulation-controller

Bom Formulation Controller

2.2.1. Get UnitOfMeasure details

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.2. Get BOM items by formulationId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

formulationId
optional

formulationId

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.3. Get PropertyDefinitions from Bom Item Property Group

GET /v1/routes-viewer/formulations/items/propertyDefinitions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.4. Get BOM item by formulationItemId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.5. Get BomItem alias Duplicate Flag Value

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulationId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.6. Check if BOM revision is enabled

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

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

Success

object

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.7. Get BOM formulations

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.8. Get PropertyDefinitions Metadata from property definitionIds

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

propertyDefinitionIds
required

List of propertiesDefinitionIds whose metadata like propertyName, DataType etc, are required.

< string > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Document-management-controller

Document Management Controller

2.3.1. Create Metadata / Create revision

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.2. Get Documents

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.3. document Upload

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.4. Get document

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.5. Get common Properties

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

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

< string, string > map

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.6. Create document reference

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.7. Get Revisions By InitialId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4. Event-sub-type-controller

Event Sub Type Controller

2.4.1. Get EventSubTypes

GET /v1/eventSubTypes/getEventSubTypes
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

HttpErrorResponse

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5. External-config-controller

External Config Controller

2.5.1. Get external Configurations

GET /external-configuration/v1/configurations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

actionId
optional

actionId

integer (int32)

Query

actionName
optional

actionName

string

Query

actionTypeId
optional

actionTypeId

integer (int32)

Query

configId
optional

configId

integer (int64)

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

ExternalConfigResponsePage

204

No Content, Error retrieving actions

HttpErrorResponse

400

Bad Request

HttpErrorResponse

401

User Unauthorized

No Content

500

Internal Server Error

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6. Historian-controller

Historian Controller

2.6.1. Get tags using alias name

GET /v1/routes-viewer/historian/{connectionAlias}/tags
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

connectionAlias
required

Alias name of historian

string

Query

name
optional

Tag name contains as a filter

string

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

size
optional

Number of resources to return per page.

integer (int32)

20
Responses
HTTP Code Description Schema

200

Success

HistorianTagPage

400

Bad request

No Content

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

No Content

503

Gateway timeout or Service Unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6.2. Get tag values

GET /v1/routes-viewer/historian/{connectionAlias}/tags/{tagName}/values
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

connectionAlias
required

Alias name of historian

string

Path

tagName
required

Tag Name

string

Query

calculationMode
required

Calculation Mode

enum (Interpolated, Tot, Min, Max, Std, Ave, MinTime, MaxTime, Count)

"Std"

Query

endTime
optional

End time as a filter. Format: yyyy-MM-dd 'T' HH:mm:ssZ (ISO), e.g. 2021-07-30T03:08:11Z

string (date-time)

Query

numberOfValues
optional

Number of values.

integer (int64)

Query

page
optional

Page number to return 0 to N.

integer (int32)

0

Query

readDirection
required

Read direction

enum (Forward, Backward)

"Backward"

Query

samplingInterval
required

Sampling interval

integer (int32)

1

Query

samplingMode
required

Sampling Mode

enum (Before, After, Exact, ExactOrBefore, Interpolated, Calculated, Raw)

"Raw"

Query

size
optional

Number of resources to return per page.

integer (int32)

20

Query

startTime
required

Start time as a filter. Format: yyyy-MM-dd 'T' HH:mm:ssZ (ISO), e.g. 2021-07-29T03:08:00Z

string (date-time)
Responses
HTTP Code Description Schema

200

Success

HistorianTagValuePage

400

Bad request

No Content

401

Unauthorized

No Content

422

Unprocessable Entity

No Content

500

Internal Server Error

No Content

503

Gateway timeout or Service Unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.6.3. Get historians with os list and historian type list

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

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

Success

Historians

400

Bad request

No Content

401

Unauthorized

No Content

500

Internal Server Error

No Content

503

Gateway timeout or Service Unavailable

No Content
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7. Labor-code-details-controller

Labor Code Details Controller

2.7.1. Add Labor code

POST /v1/laborcodes/create
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

laborCodeCreateRequest
required

Details of the labor code to create

LaborCodeCreateReq
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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.2. Get labor code by Unit, Line And Deartment

GET /v1/laborcodes/getLaborCodes
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

lineId
optional

lineId

integer (int32)

Query

unitId
optional

unitId

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.3. Get labor code by id

GET /v1/laborcodes/getLaborCodesByIds
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

laborCodeId
required

laborCodeId

< integer (int32) > array(multi)
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.7.4. Update Labor code

PUT /v1/laborcodes/update/{id}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int32)

Body

laborCodeUpdateRequest
required

Details of the labor code to update

LaborCodeUpdateReq
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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.8. Labor-type-controller

Labor Type Controller

2.8.1. Get LaborTypes

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

Header

Site-Id
required

Represents the id of the site to connect to

string
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9. Line-controller

Line Controller

2.9.1. Get all lines

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

Header

Site-Id
required

Represents the id of the site to connect to

string
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9.2. Get all lines

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.9.3. Get a single line

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.10. Permission-check-controller

Permission Check Controller

2.10.1. checkPermission

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.11. Product-controller

Product Controller

2.11.1. Get Products

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.12. Product-property-value-controller

Product Property Value Controller

2.12.1. Get property value for product

GET /v1/product/{productId}/properties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

product id

integer (int64)

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13. Property-group-controller

Property Group Controller

2.13.1. Get all property definitions

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.2. Get all revisions for property-group-definition

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.3. Get all property groups list

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.4. Get all property group with definitions list

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.5. Get property group by property group id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.6. Properties sync for route

POST /v1/properties/routes/{routeId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Body

propertyGroupIds
required

Property GroupIds

< string > array
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
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.7. Get selected list of property groups for route or segment

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Query

segmentId
optional

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.13.8. Get all property definitions by property group id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14. Route-controller

Route Controller

2.14.1. Check if ECO is enabled

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

Header

Site-Id
required

Represents the id of the site to connect to

string
Responses
HTTP Code Description Schema

200

Success

object

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.2. Create Route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.3. Get routes

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomFormulationId
optional

bomFormulationId

integer (int64)

Query

description
optional

description

string

Query

isPartialSearch
optional

isPartialSearch

boolean

"false"

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.4. Get Secret Key

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.5. Get route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.6. Delete Route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.7. Update Route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.8. Archive route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.9. Copy route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.10. Create a New Revision

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.11. Release Route

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

confirmRelease
required

confirm release flag

boolean

"false"

Path

routeId
required

routeId

integer (int64)

Body

approvalProcessRequest
optional

Approval workflow request of the route

ApprovalProcessRequest
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.14.12. Upgrade Segment

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15. Segment-controller

Segment Controller

2.15.1. Get Segment tools

GET /v1/segments-viewer/segments/tools
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

routeId
optional

routeId

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15.2. Get BOM Expiry and Sync

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Body

segmentsDefinition
required

segmentsDefinition

SegmentsDefinition
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15.3. Get Segments

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Query

bomFormulationId
optional

bomFormulationId

integer (int64)

Query

isUpdateBOMformulation
optional

isUpdateBOMformulation

boolean

"false"
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15.4. Add Segment

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

routeId
required

routeId

integer (int64)

Body

segmentDefInput
required

segmentDefInput

object
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.15.5. Get Segment

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16. Tool-category-controller

Tool Category Controller

2.16.1. Get all parent tool categories

GET /v1/routes-viewer/toolCategories/parentCategories
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.16.2. Get all parent tool categories

GET /v1/routes-viewer/toolCategories/{id}/subCategoriesAndTools
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

Category Id

integer (int32)
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.17. Tool-controller

Tool Controller

2.17.1. Wild card tool search by tool code or category name

GET /v1/tools/search
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

name
required

name

string
Responses
HTTP Code Description Schema

200

OK

< ToolSearchResponse > array

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Produces

  • application/json;charset=utf-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18. Unit-controller

Unit Controller

2.18.1. Get all departments

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

Header

Site-Id
required

Represents the id of the site to connect to

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
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.18.2. Get all units

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19. User-settings-controller

User Settings Controller

2.19.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

userSettingsRequest
required

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

request
required

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResponseResource

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

string

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.19.5. Get Privilege Sets

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20. Variable-controller

Variable Controller

2.20.1. Create DataEntryPlan

POST /v1/variables/dataEntryPlans
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

dataEntryPlanForCreation
required

create data entry plan

< DataEntryPlanForCreation > array
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.2. Update Data Entry Plan

PUT /v1/variables/dataEntryPlans
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

dataEntryPlanForUpdate
required

Updated data entry plan details

< UpdateDataEntryPlanReq > array
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.3. Duplicate Data Entry Plans

PUT /v1/variables/duplicateDataEntryPlans/{isExistingMaterial}/{routeStatus}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

isExistingMaterial
required

isExistingMaterial

boolean

"false"

Path

routeStatus
required

routeStatus

string

Body

duplicateDataEntryPlanReq
required

release data entry plans

< DuplicateDataEntryPlan > array
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.4. Get DataEntryPlans

GET /v1/variables/getDataEntryPlans
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

routeId
optional

routeId

integer (int64)

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

HttpErrorResponse

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.5. Get material variables

GET /v1/variables/getMaterialVariables/{productId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

productId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

HttpErrorResponse

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.6. Get unit variables

GET /v1/variables/getUnitVariables
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

productId
required

productId

integer (int64)

Query

unitIds
required

unitIds

< integer (int64) > array(multi)
Responses
HTTP Code Description Schema

200

OK

object

204

No Content

HttpErrorResponse

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.20.7. Release Data Entry Plans

PUT /v1/variables/releaseDataEntryPlan/{productId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

productId

integer (int64)

Body

releaseDataEntryPlanReq
required

release data entry plans

< ReleaseDataEntryPlanReq > array
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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21. Work-order-controller

Work Order Controller

2.21.1. Create work order

POST /v1/workOrders
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.2. update properties

PUT /v1/workOrders
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.3. Check work order

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.21.4. Delete work order

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

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 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 425 TOO_EARLY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED)

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

Name Schema

excludedMaterialLotActualIds
optional

< integer (int64) > array

materialLotActualIds
optional

< integer (int64) > array

3.4. ApprovalProcessRequest

Approval process request associated with route release

Name Description Schema

workFlowId
optional

Approval process workflow id.

integer (int64)

3.5. AssociatedProduct

Name Schema

associationId
optional

integer (int64)

productId
optional

integer (int64)

unitId
optional

integer (int64)

3.6. BomFormulation

Name Schema

associatedProducts
optional

< AssociatedProduct > array

behaviors
optional

< string > array

crossReferences
optional

< CrossReference > array

effectiveDate
optional

string

expirationDate
optional

string

formulationCode
optional

string

formulationDescription
optional

string

formulationItems
optional

< FormulationItem > array

isBOMAliasDuplicate
optional

boolean

producedQuantity
optional

number (double)

producedQuantityPrecision
optional

integer (int32)

producedQuantityUnitOfMeasureId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

schemaVersion
optional

integer (int64)

3.7. Class to hold tag related information

Name Description Schema

quality
optional

Quality of a historian tag data value like good, bad etc.

string

timeStamp
optional

timeStamp

string

value
optional

Historian tag data value

string

3.8. CrossReference

Name Schema

externalId
optional

string

externalSystemId
optional

integer (int64)

3.9. DataEntryPlanForCreation

Name Description Schema

eventSubtypeId
optional

integer (int64)

eventType
optional

enum (Time, ProductionEvent, Downtime, Waste, ProductChange, ProductByTime, Replix, Import, Export, Trigger, Genealogy, Alarm, UserDefined, Generic, InputMovement, InputGenealogy, InputConsumption, ProcessOrder, UnitConversion, Disposition, Uptime, Autoline, Acquidata, Valmet, ProductionEventByTime, ProcessOrderByTime, AutomatedCOAReporting, CrewSchedule, SegmentResponse, WorkResponse)

groups
optional

< DataEntryPlanGroupInfo > array

isReleased
required

True if this data entry plan is released and cannot be modified.

boolean

name
optional

string

3.10. DataEntryPlanGroupInfo

Name Schema

name
optional

string

variables
optional

< DataEntryPlanVariableInfo > array

3.11. DataEntryPlanGroupInfoForUpdate

Name Schema

name
optional

string

variables
optional

< DataEntryPlanVariableInfoForUpdate > array

3.12. DataEntryPlanVariableInfo

Name Description Schema

isMandatory
required

True if entering a value for this variable is mandatory; Otherwise, false.

boolean

preferredToolId
optional

integer (int32)

toolCategoryIds
optional

ToolCategoryList asssigned to variable

< integer (int32) > array

tools
optional

ToolList asssigned to variable

< ToolsInfo > array

variableId
required

ID of the variable associated with this data entry plan
Minimum value : -2147483648
Maximum value : 2147483647

integer (int64)

3.13. DataEntryPlanVariableInfoForUpdate

Name Schema

isMandatory
optional

boolean

preferredToolId
optional

integer (int32)

toolCategoryIds
optional

< integer (int32) > array

tools
optional

< ToolsInfo > array

variableId
optional

integer (int64)

3.14. Document

Name Schema

displayName
optional

string

link
optional

string

3.15. DuplicateDataEntryPlan

Name Schema

dataEntryPlanId
optional

< integer (int64) > array

segmentId
optional

integer (int64)

3.16. Error

Name Schema

code
optional

string

details
optional

object

3.17. ExternalConfigResponse

Name Schema

actionId
optional

integer (int64)

actionName
optional

string

actionType
optional

string

actionTypeId
optional

integer (int64)

configId
optional

integer (int64)

createdBy
optional

string

data
optional

object

deleted
optional

boolean

id
optional

integer (int64)

updatedBy
optional

string

3.18. ExternalConfigResponsePage

Name Schema

content
optional

< ExternalConfigResponse > array

links
optional

Links

page
optional

PageMetadata

3.19. FormulationItem

Name Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

displayOrder
optional

integer (int32)

itemId
optional

integer (int64)

itemReference
optional

string

locationId
optional

integer (int64)

lotDescription
optional

string

lowerTolerance
optional

number (double)

lowerTolerancePrecision
optional

integer (int64)

productCode
optional

string

productDescription
optional

string

productId
optional

integer (int64)

propertyValues
optional

< PropertyValues > array

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

scrapFactor
optional

number (double)

substitutions
optional

< Substitution > array

unitId
optional

integer (int64)

unitName
optional

string

unitOfMeasureId
optional

integer (int64)

uomCode
optional

string

uomDescription
optional

string

upperTolerance
optional

number (double)

upperTolerancePrecision
optional

integer (int64)

3.20. FormulationItemsConsumption

Name Schema

behaviors
optional

< string > array

itemReference
optional

string

lowerTolerance
optional

number (double)

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

upperTolerance
optional

number (double)

3.21. Historian

Name Schema

active
optional

boolean

alias
optional

string

histDefault
optional

boolean

histId
optional

integer (int64)

histPassword
optional

string

histPassword2
optional

string

histServername
optional

string

histTypeDesc
optional

string

histTypeDllName
optional

string

histTypeId
optional

integer (int64)

histUsername
optional

string

osDesc
optional

string

osId
optional

integer (int64)

remote
optional

boolean

3.22. HistorianTagPage

Name Schema

content
optional

< HistorianTagResource > array

links
optional

Links

page
optional

PageMetadata

3.23. HistorianTagResource

Name Description Schema

dataType
optional

Data type of a tag server

string

description
optional

description

string

engineeringUnits
optional

engineeringUnits

string

historianTagValueInfo
optional

Class having value a of historian tag data

Class to hold tag related information

links
optional

Links

tagName
optional

Tag Name

string

3.24. HistorianTagValuePage

Name Schema

content
optional

< HistorianTagValueResource > array

links
optional

Links

page
optional

PageMetadata

3.25. HistorianTagValueResource

Name Description Schema

links
optional

Links

quality
optional

Quality of a historian tag data value like good, bad etc.

string

timeStamp
optional

timeStamp

string

value
optional

Historian tag data value

string

3.26. HistorianTypes

Name Schema

histTypeDesc
optional

string

histTypeDllName
optional

string

histTypeId
optional

integer (int64)

3.27. Historians

Name Schema

historianList
optional

< Historian > array

historianTypeList
optional

< HistorianTypes > array

operatingSystemList
optional

< OperatingSystems > array

3.28. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.29. LaborCodeCreateReq

Name Schema

appliesToMachine
optional

boolean

appliesToPeople
optional

boolean

deptId
optional

integer (int32)

displayName
optional

string

externalId
optional

string

inspectionFactor
optional

number (float)

lineId
optional

integer (int32)

runFactor
optional

number (float)

setupFactor
optional

number (float)

transportFactor
optional

number (float)

unitId
optional

integer (int32)

3.30. LaborCodeUpdateReq

Name Schema

displayName
optional

string

externalId
optional

string

inspectionFactor
optional

number (float)

runFactor
optional

number (float)

setupFactor
optional

number (float)

transportFactor
optional

number (float)

3.31. LaborPlan

Name Schema

laborCodes
optional

< integer (int64) > array

standardLaborPlan
optional

< LaborPlanItem > array

3.32. LaborPlanItem

Name Schema

basis
optional

enum (item, lot)

laborPlanningTypeId
optional

integer (int64)

time
optional

integer (int64)

3.33. Link

Name Schema

deprecation
optional

string

href
optional

string

hreflang
optional

string

media
optional

string

name
optional

string

profile
optional

string

rel
optional

string

template
optional

UriTemplate

templated
optional

boolean

title
optional

string

type
optional

string

3.34. Links

Name Schema

empty
optional

boolean

3.35. MaterialLotEntryRequest

Name Schema

lotIdentifier
optional

string

plannedQuantity
optional

integer (int32)

3.36. OperatingSystems

Name Schema

osDesc
optional

string

osId
optional

integer (int64)

3.37. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.38. PlannedUnit

Name Schema

machinePlan
optional

LaborPlan

peoplePlan
optional

LaborPlan

unitId
optional

integer (int64)

3.39. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.40. PropertyValues

Name Schema

propertyDefinitionId
optional

string

propertyValue
optional

string

3.41. ReleaseDataEntryPlanReq

Name Schema

dataEntryPlanId
optional

integer (int64)

unitId
optional

< integer (int64) > array

3.42. RouteForCreateInfo

Name Description Schema

bomFormulationId
optional

bomFormulationId of the route

integer (int64)

description
optional

description of the route record

string

minorRevision
optional

minor revision of the route record

integer (int32)

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)

revisionReason
optional

revision reason of the route record

string

secretKey
optional

secretkey of the BFF request

string

status
optional

status of the route record

string

3.43. RouteForStatusUpdateInfo

Route data tranfer object for update

Name Description Schema

status
required

Status of the route record

string

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

revisionReason
optional

revisionReason of the route record

string

status
optional

Status of the route record

string

3.45. Segment

Name Schema

appliesTo
optional

AppliesTo

behaviors
optional

< string > array

dataEntryPlans
optional

< integer (int64) > array

description
optional

string

documents
optional

< Document > array

formulationItemsConsumption
optional

< FormulationItemsConsumption > array

name
optional

string

plannedUnits
optional

< PlannedUnit > array

propertyValues
optional

< PropertyValues > array

segmentId
optional

integer (int64)

segmentType
optional

enum (group, route, segment)

suggestedLaborTypes
optional

< integer (int64) > array

3.46. SegmentsDefinition

Name Schema

bomFormulation
optional

BomFormulation

bomFormulationId
optional

integer (int64)

plannedLineId
optional

integer (int64)

producedMaterialId
optional

integer (int64)

schemaVersion
optional

integer (int32)

segments
optional

< Segment > array

structure
optional

Structure

structureType
optional

enum (tree, simple)

3.47. SequenceElement

Name Schema

children
optional

< SequenceElement > array

displayOrder
optional

integer (int64)

mutualExclusionSets
optional

< integer (int64) > array

segmentId
optional

integer (int64)

sequenceNumber
optional

integer (int64)

skipIfSuccessorStarted
optional

boolean

3.48. Structure

Name Schema

sequence
optional

SequenceElement

3.49. Substitution

Name Schema

conversionFactor
optional

number (double)

productCode
optional

string

productDescription
optional

string

productId
optional

integer (int64)

quantity
optional

number (double)

quantityPrecision
optional

integer (int32)

substitutionOrder
optional

integer (int32)

uom
optional

integer (int64)

uomCode
optional

string

uomDescription
optional

string

3.50. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

enum (, ?, &, /, #, *)

3.51. ToolSearchResponse

Name Schema

calibrationDueDate
optional

string (date-time)

description
optional

string

hierarchyLevel
optional

integer (int32)

id
optional

integer (int32)

isCustomTool
optional

boolean

lastCalibrationDate
optional

string (date-time)

manufacturer
optional

string

name
optional

string

parentId
optional

integer (int32)

serialNumber
optional

string

status
optional

string

toolsCount
optional

integer (int32)

type
optional

enum (TOOLCATEGORY, TOOL)

3.52. ToolsInfo

Name Schema

isPrefered
optional

boolean

toolId
optional

integer (int32)

3.53. UpdateDataEntryPlanReq

Name Schema

eventSubtypeId
optional

integer (int64)

eventType
optional

enum (Time, ProductionEvent, Downtime, Waste, ProductChange, ProductByTime, Replix, Import, Export, Trigger, Genealogy, Alarm, UserDefined, Generic, InputMovement, InputGenealogy, InputConsumption, ProcessOrder, UnitConversion, Disposition, Uptime, Autoline, Acquidata, Valmet, ProductionEventByTime, ProcessOrderByTime, AutomatedCOAReporting, CrewSchedule, SegmentResponse, WorkResponse)

groups
optional

< DataEntryPlanGroupInfoForUpdate > array

id
optional

integer (int64)

name
optional

string

3.54. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.55. 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.56. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

3.57. WorkOrder

Work order Data transfer object

Name Description Schema

cancelledOn
optional

Date that the work order was cancelled.

string (date-time)

completedBy
optional

The user that completed the work order.

string

completedOn
optional

Date that the work order was completed.

string (date-time)

createdBy
optional

User that created the work order.

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

string

lastModifiedOn
optional

Date that the work order was last modified.

string (date-time)

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.58. WorkOrderCreationRequest

Name Schema

materialLotEntries
optional

< MaterialLotEntryRequest > array

name
optional

string

plannedEndDate
optional

string (date-time)

plannedQuantity
optional

integer (int32)

plannedStartDate
optional

string (date-time)

priority
optional

integer (int32)

producedMaterialId
optional

integer (int64)

productionLineId
optional

integer (int64)

routeDefinitionId
optional

integer (int64)

3.59. WorkOrderExistsResponse

Name Schema

exists
optional

boolean

id
optional

integer (int64)

status
optional

string

3.60. WorkOrderProperties

WorkOrderProperties data tranfer object

Name Schema

propertiesDefInfoList
optional

< PropertyValues > array

segementDefinitionId
optional

integer (int64)

3.61. WorkOrderPropertiesUpdateRequest

WorkOrderPropertiesUpdateRequest data tranfer object

Name Schema

bomFormulationId
optional

integer (int64)

workOrderId
optional

integer (int64)

workOrderPropertiesList
optional

< WorkOrderProperties > array

3.62. WorkflowConfigurationInfo

Name Schema

active
optional

boolean

coOwner
optional

string

createdBy
optional

string

createdOn
optional

string (date-time)

equipementId
optional

integer (int64)

id
optional

integer (int64)

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

lineId
optional

integer (int64)

name
optional

string

revision
optional

integer (int32)

workflowEventName
optional

string

3.63. WorkflowConfigurationInfosPage

Name Schema

content
optional

< WorkflowConfigurationInfo > array

links
optional

< Link > array

page
optional

PageMetadata

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.