1. Overview

Microservice containing the business logic for bom management

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

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

  • bom-family-controller : Bom Family Controller

  • bom-formulation-controller : Bom Formulation Controller

  • product-controller : Product Controller

  • property-definition-controller : Property Definition Controller

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Approval-workflow-event-controller

Approval Workflow Event Controller

2.1.1. Get the WorkFlow Configurations by Event Id.

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

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-family-controller

Bom Family Controller

2.2.1. Add New BOM Family

POST /bom/bomFamilies
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomFamily
required

bomFamily

BomFamilyCreateInfo
Responses
HTTP Code Description Schema

201

Created.

BomFamilyInfo

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

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 Families

GET /bom/bomFamilies
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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.3. Add New Master Bill Of Material

POST /bom/bomMasters
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomMaster
required

bomMaster

BomMasterRequest
Responses
HTTP Code Description Schema

200

OK

object

201

Created.

BomMasterResponse

400

Invalid data supplied. See message for details.

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

422

Unprocessable Entity

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

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 Masters

GET /bom/bomMasters
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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.2.5. Get BOM Master by id

GET /bom/bomMasters/{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)
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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3. Bom-formulation-controller

Bom Formulation Controller

2.3.1. Create BOM Formulation

POST /bomFormulations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomFormulationRequest
required

bomFormulationRequest

BomFormulationForCreate
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service unavailable

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 All BOM formulations

GET /bomFormulations
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

bomFormulationDescription
optional

bomFormulationDescription to get a list of BOM formulation details.

string

Query

isPartialSearch
optional

isPartialSearch

boolean

Query

page
optional

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

integer (int32)

Query

productId
optional

productID to get a list of BOM formulation details.

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)

20

Query

status
optional

status

string
Responses
HTTP Code Description Schema

200

OK

BomFormulationInfoResults

401

Unauthorized

No Content

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.3. Update BOM Formulation

PUT /bomFormulations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomFormulationUpdateRequest
required

bomFormulationUpdateRequest

BomFormulationForUpdate
Responses
HTTP Code Description Schema

200

Success

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service unavailable

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.4. Check if BOM revision is enabled

GET /bomFormulations/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.3.5. Check if eco is enabled

GET /bomFormulations/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.3.6. Get BOM formulation by Id

GET /bomFormulations/{formulationId}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulation id to get a BOM formulation

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BomFormulationInfo

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.3.7. Archive BOM formulation

PATCH /bomFormulations/{formulationId}/archive
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

BOM formulation Id

integer (int64)

Body

formulationRequestForArchive
required

Archive BOM formulation request

BomFormulationRequestForArchive
Responses
HTTP Code Description Schema

200

Ok

BomFormulationInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Un-processable Entity

HttpErrorResponse

503

Service Unavailable

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.8. Create BOM Formulation Items

POST /bomFormulations/{formulationId}/items
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)

Body

bomFormulationItems
required

bomFormulationItems

< BomFormulationItemForCreate > array
Responses
HTTP Code Description Schema

201

Created

object

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

GET /bomFormulations/{formulationId}/items
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulationId to get a list of BOM items

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.3.10. Update BOM Formulation Items

PUT /bomFormulations/{formulationId}/items
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)

Body

bomFormulationItemsForUpdate
required

bomFormulationItemsForUpdate

< BomFormulationItemForUpdate > array
Responses
HTTP Code Description Schema

200

Success

object

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.3.11. Delete BOM Formulation Items

DELETE /bomFormulations/{formulationId}/items
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)

Query

formulationItemIds
required

formulationItemIds

string
Responses
HTTP Code Description Schema

204

No Content

object

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.3.12. Create/Update/Delete BOM Formulation Items With Substitutions

PUT /bomFormulations/{formulationId}/items/save
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)

Body

bomFormulationItemsForSave
required

bomFormulationItemsForSave

BomFormulationItemsForSave
Responses
HTTP Code Description Schema

200

Success

object

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.3.13. Release a BOM formulation

POST /bomFormulations/{formulationId}/release
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

BOM formulation Id

integer (int64)

Body

bomApprovalRequest
optional

BOM formulation approval request

BomApprovalRequest
Responses
HTTP Code Description Schema

200

Ok

BomFormulationInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Un-processable Entity

HttpErrorResponse

503

Service Unavailable

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.14. Create BOM Formulation Revision

POST /bomFormulations/{formulationId}/revisions
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)

Body

bomFormulationRequest
required

bomFormulationRequest

BomFormulationForRevision
Responses
HTTP Code Description Schema

201

Created

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service unavailable

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

Product Controller

2.4.1. Get all engineering units

GET /engineeringUnits
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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.2. Get Products

GET /products
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.4.3. Get units

GET /units
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

  • /

Security
Type Name Scopes

oauth2

access_token

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

oauth2

client_creds

default

2.5. Property-definition-controller

Property Definition Controller

2.5.1. Get propertyDefinitions of the BomItemImport group

GET /v1/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

PropertyDefinitionsPage

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

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

User Settings Controller

2.6.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.6.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.6.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.6.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.6.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

3. Definitions

3.1. BomApprovalRequest

Approval process request associated with BOM release

Name Description Schema

workFlowId
optional

Approval process workflow id.

integer (int64)

3.2. BomFamilyCreateInfo

Name Description Schema

description
optional

The BOM family’s description

string

3.3. BomFamilyInfo

Name Description Schema

description
optional

The BOM family’s description

string

id
optional

The unique Id of the BOM family

integer (int64)

3.4. BomFormulationForCreate

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

description
optional

BOM Formulation description.

string

effectiveDate
optional

Effective date and time of the formulation.

string (date-time)

expirationDate
optional

Date and time at which the formulation will expire.

string (date-time)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

The number of decimal places to which the Quantity will be displayed.

integer (int32)

reason
optional

Reason for BOM Creation

string

standardQuantity
optional

Quantity this formulation produces.

number (double)

uom
optional

Units of measure used in Quantity.

integer (int64)

3.5. BomFormulationForRevision

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

description
optional

BOM Formulation description.

string

effectiveDate
optional

Effective date and time of the formulation.

string (date-time)

expirationDate
optional

Date and time at which the formulation will expire.

string (date-time)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

The number of decimal places to which the Quantity will be displayed.

integer (int32)

reason
optional

Reason for BOM Creation

string

revision
required

Revision of the BOM formulation

integer (int32)

standardQuantity
optional

Quantity this formulation produces.

number (double)

uom
optional

Units of measure used in Quantity.

integer (int64)

3.6. BomFormulationForUpdate

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

description
optional

BOM Formulation description.

string

descriptionForRevision
optional

Revision of the BOM formulation

string

effectiveDate
optional

Effective date and time of the formulation.

string (date-time)

expirationDate
optional

Date and time at which the formulation will expire.

string (date-time)

id
optional

BOM Formulation id to update.

integer (int64)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

The number of decimal places to which the Quantity will be displayed.

integer (int32)

reason
optional

Reason for BOM Creation

string

revision
required

Revision of the BOM formulation

integer (int32)

standardQuantity
optional

Quantity this formulation produces.

number (double)

status
optional

Status of the BOM formulation

string

uom
optional

Units of measure used in Quantity.

integer (int64)

3.7. BomFormulationInfo

Name Description Schema

bomFamilyId
optional

integer (int32)

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

count
optional

Revision count of the BOM formulation.

integer (int64)

createdBy
optional

User that created the formulation

string

createdOn
optional

Date that the formulation was created.

string (date-time)

description
optional

Formulation description of a BOM

string

ecoNumber
optional

string

effectiveDate
optional

Formulation effective Date

string (date-time)

expirationDate
optional

Formulation expiration Date

string (date-time)

id
optional

BOM Formulation id

integer (int64)

lastModifiedBy
optional

User that last modified the formulation.

string

lastModifiedOn
optional

Date that the formulation was last modified.

string (date-time)

maxRevisionNumber
optional

MaximumRevision number of a BOM.

integer (int32)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

products
optional

< ProductResponse > array

quantityPrecision
optional

Quantity Precision

integer (int32)

reason
optional

Reason for BOM Creation

string

revision
optional

Revision of the BOM formulation

integer (int32)

standardQuantity
optional

standard quantity

number (double)

status
optional

Status of the BOM formulation.

string

uom
optional

Eng unit Id

integer (int64)

uomCode
optional

string

3.8. BomFormulationInfoResult

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

count
optional

Revision count of the BOM formulation.

integer (int64)

createdBy
optional

User that created the formulation

string

createdOn
optional

Date that the formulation was created.

string (date-time)

description
optional

Formulation description of a BOM

string

effectiveDate
optional

Formulation effective Date

string (date-time)

expirationDate
optional

Formulation expiration Date

string (date-time)

id
optional

BOM Formulation id

integer (int64)

lastModifiedBy
optional

User that last modified the formulation.

string

lastModifiedOn
optional

Date that the formulation was last modified.

string (date-time)

links
optional

< Link > array

maxRevisionNumber
optional

MaximumRevision number of a BOM.

integer (int32)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

Quantity Precision

integer (int32)

reason
optional

Reason for BOM Creation

string

revision
optional

Revision of the BOM formulation

integer (int32)

standardQuantity
optional

standard quantity

number (double)

status
optional

Status of the BOM formulation.

string

uom
optional

Eng unit Id

integer (int64)

3.9. BomFormulationInfoResults

Name Schema

content
optional

< BomFormulationInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.10. BomFormulationItemForCreate

Name Description Schema

alias
optional

bom formulation item alias

string

lowerTolerance
optional

The minimum quantity, measured in the selected engineering units, of the formulation item that must be used in the formulation.

number (double)

lowerTolerancePrecision
optional

The number of decimal places to which the Lower Tolerance will be displayed.

integer (int32)

productId
optional

Product id to add to the formulation.

integer (int64)

quantity
optional

Quantity of selected product used in this formulation.

number (double)

quantityPrecision
optional

The number of decimal places to which the Quantity will be displayed.

integer (int32)

scrapFactor
optional

Percentage of this formulation item that is expected to be lost during production of the formulation. For example, if 100 units of Product XYZ is required with a scrap factor of 1%, then you should have a 101 units on hand when preparing to produce the product.

number (double)

storageUnit
optional

Unit currently storing the selected product.

integer (int64)

uom
optional

Engineering units used to measure Quantity.

integer (int64)

upperTolerance
optional

The maximum quantity, measured in the selected engineering units, of the formulation item that can be used in the formulation.

number (double)

upperTolerancePrecision
optional

The number of decimal places to which the Upper Tolerance will be displayed.

integer (int32)

3.11. BomFormulationItemForUpdate

Name Description Schema

alias
optional

bom formulation item alias

string

id
optional

bom formulation item id to update.

integer (int64)

isMarkedForDelete
optional

Flag to delete BOM item

boolean

lowerTolerance
optional

The minimum quantity, measured in the selected engineering units, of the formulation item that must be used in the formulation.

number (double)

lowerTolerancePrecision
optional

The number of decimal places to which the Lower Tolerance will be displayed.

integer (int32)

productId
optional

Product id to add to the formulation.

integer (int64)

quantity
optional

Quantity of selected product used in this formulation.

number (double)

quantityPrecision
optional

The number of decimal places to which the Quantity will be displayed.

integer (int32)

scrapFactor
optional

Percentage of this formulation item that is expected to be lost during production of the formulation. For example, if 100 units of Product XYZ is required with a scrap factor of 1%, then you should have a 101 units on hand when preparing to produce the product.

number (double)

storageUnit
optional

Unit currently storing the selected product.

integer (int64)

substitutions
optional

< BomSubstitution > array

uom
optional

Engineering units used to measure Quantity.

integer (int64)

upperTolerance
optional

The maximum quantity, measured in the selected engineering units, of the formulation item that can be used in the formulation.

number (double)

upperTolerancePrecision
optional

The number of decimal places to which the Upper Tolerance will be displayed.

integer (int32)

3.12. BomFormulationItemsForSave

Name Schema

formulationItemsForUpdate
optional

< BomFormulationItemForUpdate > array

3.13. BomFormulationRequestForArchive

Request object for archiving a BOM formulation

Name Description Schema

status
required

Status of the BOM formulation

string

3.14. BomMasterRequest

Name Description Schema

description
optional

Description

string

familyId
optional

Family Id

integer (int32)

3.15. BomMasterResponse

Name Description Schema

description
optional

The BOM Master description

string

id
optional

The unique Id of the BOM Master

integer (int64)

3.16. BomSubstitution

Name Description Schema

conversionFactor
optional

number (double)

isMarkedForDelete
optional

Flag to delete BOM substitution item

boolean

productId
optional

integer (int32)

substitutionId
optional

integer (int64)

substitutionOrder
optional

integer (int32)

unitOfMeasure
optional

integer (int32)

3.17. Error

Name Schema

code
optional

string

details
optional

object

3.18. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.19. 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.20. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.21. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.22. ProductResponse

Name Schema

productDescription
optional

string

productId
optional

integer (int64)

productName
optional

string

3.23. PropertyDefinitionInfo

Name Schema

createdBy
optional

string

createdOn
optional

string (date-time)

defaultValue
optional

string

deleted
optional

boolean

displayName
optional

string

groupCreatedBy
optional

string

groupCreatedOn
optional

string (date-time)

id
optional

string

initialId
optional

string

lastModifiedBy
optional

string

lastModifiedOn
optional

string (date-time)

name
optional

string

propertyCategoryId
optional

string

propertyCategoryName
optional

string

propertyDataType
optional

string

propertyDataTypeId
optional

integer (int32)

propertyGroupId
optional

string

propertyGroupName
optional

string

protected
optional

boolean

required
optional

boolean

uom
optional

integer (int32)

version
optional

integer (int32)

3.24. PropertyDefinitionsPage

Name Schema

content
optional

< PropertyDefinitionInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.25. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

3.26. TemplateVariables

Type : object

3.27. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

< TemplateVariable > array

3.28. 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.29. UserSettingResponseResource

Name Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

boolean

links
optional

< Link > array

viewName
optional

string

3.30. 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.31. 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://DRAGONWIN001.meridium.com/uaa/oauth/authorize
Token URL : https://DRAGONWIN001.meridium.com/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://DRAGONWIN001.meridium.com/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://DRAGONWIN001.meridium.com/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://DRAGONWIN001.meridium.com/uaa/oauth/token

Name Description

default

Default oauth2 scope.