1. Overview

Microservice containing the business logic for managing product-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • bom-family-controller : Bom Family Controller

  • bom-formulation-controller : Bom Formulation Controller

  • bom-master-controller : Bom Master Controller

  • consumption-operations-controller : Consumption Operations Controller

  • engineering-units-controller : Engineering Units Controller

  • material-lot-command-controller : Material Lot Command Controller

  • material-lot-controller : Material Lot Controller

  • material-lot-property-group-controller : Material Lot Property Group Controller

  • material-lot-status-controller : Material Lot Status Controller

  • material-traceability-controller : Material Traceability Controller

  • product-controller : Product Controller

  • product-execution-path-controller : Product Execution Path Controller

  • product-family-controller : Product Family Controller

  • product-group-controller : Product Group Controller

  • product-property-group-controller : Product Property Group Controller

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

  • product-unit-controller : Product Unit Controller

  • reallocation-operations-controller : Reallocation Operations Controller

  • unit-engineering-unit-controller : Unit Engineering Unit Controller

2. Resources

2.1. Bom-family-controller

Bom Family Controller

2.1.1. Get All BOM Families

GET /bomFamilies
Responses
HTTP Code Description Schema

200

OK

BomFamilyPage

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.1.2. Get BOM Family by ID

GET /bomFamilies/{bomFamilyId}
Parameters
Type Name Description Schema

Path

bomFamilyId
required

bomFamilyId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

BomFamily

401

Unauthorized

No Content

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2. Bom-formulation-controller

Bom Formulation Controller

2.2.1. Create BOM Formulation

POST /formulations
Parameters
Type Name Description Schema

Body

bomFormulationRequest
required

Details on the bom formulation to create.

BomFormulationForCreate
Responses
HTTP Code Description Schema

201

Created

BomFormulationInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.2. Get BOM Formulations

GET /formulations
Parameters
Type Name Description Schema

Query

bomFormulationDescription
optional

bomFormulationDescription to get a list of BOM formulation details.

string

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)
Responses
HTTP Code Description Schema

200

OK

BomFormulationInfoResults

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.3. Get BOM Formulation Item by Id

GET /formulations/items/{formulationItemId}
Parameters
Type Name Description Schema

Path

formulationItemId
required

formulation Item id to get a BOM formulation item

integer (int64)
Responses
HTTP Code Description Schema

200

OK

BomFormulationItem

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.4. Get BOM Formulation by Id

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

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.5. Update BOM Formulation

PUT /formulations/{formulationId}
Parameters
Type Name Description Schema

Path

formulationId
required

formulationId to be updated.

integer (int64)

Body

bomFormulationForUpdate
required

Details on the bom formulation to update.

BomFormulationForUpdate
Responses
HTTP Code Description Schema

200

Success

BomFormulationInfo

204

No Content

BomFormulationInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/vnd.ge.mes.v1.update+json

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.6. Delete BOM Formulation

DELETE /formulations/{formulationId}
Parameters
Type Name Description Schema

Path

formulationId
required

formulationId of the BOM Formulation to be deleted

integer (int64)
Responses
HTTP Code Description Schema

204

Success

object

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.7. Create BOM Formulation Items

POST /formulations/{formulationId}/items
Parameters
Type Name Description Schema

Path

formulationId
required

formulationId of the BOM Formulation Item to be updated.

integer (int64)

Body

item
required

Details on the bom formulation item to create.

BomFormulationItemForCreate
Responses
HTTP Code Description Schema

201

Success

BomFormulationItem

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.8. Get BOM items by BOM formulationId

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

Path

formulationId
required

formulationId to get a list of BOM items

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< BomFormulationItemResult > array

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.9. Update BOM Formulation Items

PUT /formulations/{formulationId}/items/{formulationItemId}
Parameters
Type Name Description Schema

Path

formulationId
required

formulationId of the BOM Formulation Item to be updated.

integer (int64)

Path

formulationItemId
required

bom formulation item id to update.

integer (int64)

Body

item
required

Details on the bom formulation item to update.

BomFormulationItemForUpdate
Responses
HTTP Code Description Schema

200

Success

BomFormulationItem

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/vnd.ge.mes.v1.update+json

  • application/json;charset=UTF-8

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.2.10. Delete BOM Formulation Item

DELETE /formulations/{formulationId}/items/{formulationItemId}
Parameters
Type Name Description Schema

Path

formulationId
required

ID of the BOM Formulation to be deleted.

integer (int64)

Path

formulationItemId
required

ID of the BOM Formulation Item to be deleted.

integer (int64)
Responses
HTTP Code Description Schema

204

Success

object

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.3. Bom-master-controller

Bom Master Controller

2.3.1. Get All BOM Masters

GET /bomMasters
Responses
HTTP Code Description Schema

200

OK

BomMasterPage

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.3.2. Get BOM Master by ID

GET /bomMasters/{bomMasterId}
Parameters
Type Name Description Schema

Path

bomMasterId
required

bomMasterId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

BomMaster

401

Unauthorized

No Content

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.4. Consumption-operations-controller

Consumption Operations Controller

2.4.1. Create a consumption record

POST /consumptionOperations
Parameters
Type Name Description Schema

Query

resourceId
optional

resourceId

integer (int32)

Query

resourceType
optional

resourceType

string

Body

consumptionRecord
required

consumptionRecord

ConsumptionRecordRequest
Responses
HTTP Code Description Schema

201

Created

ConsumptionRecordInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.4.2. Get Consumption lots

GET /consumptionOperations
Parameters
Type Name Description Schema

Query

bomItemId
optional

Consumption records for bomItemId.

integer (int64)

Query

id
optional

ID of consumption record / Component_Id of event_components.

integer (int64)

Query

page
optional

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

integer (int32)

Query

segmentId
optional

Consumption records for segmentId.

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)

Query

sourceMaterialLotId
optional

Source Material Lot ID the product being consumed.

integer (int64)

Query

targetMaterialLotId
optional

Target material Lot IDs the product being manufactured.

< integer (int64) > array(multi)

Query

workOrderId
optional

Consumption records for workOrderId.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ConsumptionRecordInfoPage

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.5. Engineering-units-controller

Engineering Units Controller

2.5.1. Get all uom (engineering units)

GET /engineeringUnits
Parameters
Type Name Description Schema

Query

active
optional

engineering unit active to get uom details

boolean

Query

code
optional

engineering unit code to get uom details

string

Query

description
optional

engineering unit description to get uom details

string

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

UnitOfMeasurePage

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.5.2. Get uom (an engineering unit)

GET /engineeringUnits/{engineeringUnitId}
Parameters
Type Name Description Schema

Path

engineeringUnitId
required

engineering unit ID to get uom details

integer (int64)
Responses
HTTP Code Description Schema

200

OK

UnitOfMeasure

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.6. Material-lot-command-controller

Material Lot Command Controller

2.6.1. Create scrap producton event

POST /materialLots/{materialLotId}/scrap
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLotId

integer (int64)

Body

materialLotCommandInfo
required

materialLotCommandInfo

MaterialLotCommandInfo
Responses
HTTP Code Description Schema

200

OK

string

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7. Material-lot-controller

Material Lot Controller

2.7.1. Create a material lot

POST /materialLots
Parameters
Type Name Description Schema

Query

resourceId
optional

resourceId

integer (int32)

Query

resourceType
optional

resourceType

string

Body

materialLotInfo
required

materialLotInfo

MaterialLotInfo
Responses
HTTP Code Description Schema

201

Created

MaterialLotInfoResult

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.2. Get list of materialLots and their properties

GET /materialLots
Parameters
Type Name Description Schema Default

Query

availableForConsumption
optional

Status of the item is available for consumption or not.

boolean

Query

excludeEmptyLots
optional

excludeEmptyLots to retrieve properties of materialLots.

boolean

Query

includeLotsWithImplicitProduct
optional

Include Lots With Implicit Product. Default value false productId data populates only from appliedProduct and appliedProduct is not null. True will populates all products and inlcludes implicit products.

boolean

"false"

Query

lotIdentifier
optional

lot identifier (use lot_identifier/event_num for this property)

string

Query

page
optional

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

integer (int32)

Query

processOrderId
optional

Process order id to retreive the material lots.

integer (int64)

Query

productId
optional

Product ID (applied product id) to retrieve properties of materialLots.

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)

Query

statusIds
optional

Status Ids (status of the event)

string

Query

unitIds
optional

Unit IDs (ids of the unit the event is for) to retrieve properties of materialLots.

string
Responses
HTTP Code Description Schema

200

OK

MaterialLotInfoResults

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.3. Get the specific materialLot by materialLotId

GET /materialLots/{materialLotId}
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLotId to get the specific lot details within that lot.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

MaterialLotInfoResult

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.4. Update a material lot

PUT /materialLots/{materialLotId}
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLotId

integer (int64)

Body

materialLotUpdateInfo
required

materialLotUpdateInfo

MaterialLotUpdateInfo
Responses
HTTP Code Description Schema

200

OK

MaterialLotInfoResult

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.5. Update Material lot Override quantities

POST /materialLots/{materialLotId}/overrideQuantities
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLot id

integer (int64)

Body

materialLotOveQuaRequest
required

materialLotOveQuaRequest

MaterialLotOverrideQuantitiyRequest
Responses
HTTP Code Description Schema

201

Created

MaterialLotOverrideQuantitiyResponseResult

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.6. Get list of materialLots properties

GET /materialLots/{materialLotId}/propertyValues
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLot 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

MaterialLotPropertyResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal server error

No Content

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.7.7. update materiallot property values

PUT /materialLots/{materialLotId}/propertyValues
Parameters
Type Name Description Schema

Path

materialLotId
required

materialLot id

integer (int64)

Body

propertyDefinitionInfo
required

PropertyDefinitionUpdateInfo

< ProductPropertyDefinitionUpdateInfo > array
Responses
HTTP Code Description Schema

200

OK

< PropertyValue > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.8. Material-lot-property-group-controller

Material Lot Property Group Controller

2.8.1. Get property groups of material lot

GET /v1/globalMaterialLotPropertyGroups
Parameters
Type Name Description Schema

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

PropertyGroupPage

401

Unauthorized

No Content

500

Internal server error

No Content

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.8.2. Update material lot property groups

PUT /v1/globalMaterialLotPropertyGroups
Parameters
Type Name Description Schema

Body

materialLotPropertyGroupUpdateInfo
required

Property Group Ids

< string > array
Responses
HTTP Code Description Schema

200

OK

MaterialLotPropertyGroupInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.9. Material-lot-status-controller

Material Lot Status Controller

2.9.1. Get All MaterialLot Statuses

GET /materialLotStatuses
Responses
HTTP Code Description Schema

200

OK

< MaterialLotStatusResult > array

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.9.2. Get MaterialLot Status by materialLotStatusId

GET /materialLotStatuses/{materialLotStatusId}
Parameters
Type Name Description Schema

Path

materialLotStatusId
required

MaterialLot Status ID To Get a MaterialLot Status.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

MaterialLotStatus

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.10. Material-traceability-controller

Material Traceability Controller

2.10.1. Create Material Traceability Record

POST /materialTraceabilityRecords
Parameters
Type Name Description Schema

Body

materialLotTraceabilityRequest
required

materialLotTraceabilityRequest

MaterialTraceabilityRequest
Responses
HTTP Code Description Schema

201

Created

MaterialTraceabilityRecord

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.10.2. Get MaterialTraceability Record

GET /materialTraceabilityRecords
Parameters
Type Name Description Schema

Query

id
optional

ID of MaterialTraceabilityRecord / Component_Id of event_components.

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)

Query

sourceMaterialLotId
optional

Source Material Lot ID the Receiver MaterialLot.

integer (int64)

Query

targetMaterialLotId
optional

Target material Lot IDs non-Receiver MaterialLot.

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

200

OK

MaterialTraceabilityRecordInfoPage

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.11. Product-controller

Product Controller

2.11.1. Create Product

POST /product/v1/products
Parameters
Type Name Description Schema

Body

productCreateInfo
required

productCreateInfo

ProductCreateInfo
Responses
HTTP Code Description Schema

201

Created

ProductInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.11.2. Get products

GET /product/v1/products
Parameters
Type Name Description Schema

Query

code
optional

code

string

Query

description
optional

description

string

Query

isSerialized
optional

isSerialized

boolean

Query

page
optional

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

integer (int32)

Query

productFamilyIds
optional

productFamilyIds

string

Query

productGroupIds
optional

productGroupIds

string

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductPage

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

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.11.3. Get product by ID

GET /product/v1/products/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

Product

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content

404

Not Found

No Content
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.11.4. Update Product

PUT /product/v1/products/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Body

productUpdateInfo
required

productUpdateInfo

ProductUpdateInfo
Responses
HTTP Code Description Schema

200

OK

ProductInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.11.5. Delete Product By Id

DELETE /product/v1/products/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.12. Product-execution-path-controller

Product Execution Path Controller

2.12.1. Get product execution paths

GET /product/v1/executionPaths
Parameters
Type Name Description Schema

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

ProductExecutionPathPage

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.12.2. Get active product execution paths for given productId

GET /product/v1/products/{id}/executionPaths
Parameters
Type Name Description Schema

Path

id
required

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

ProductExecutionPathPage

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.12.3. Associate/Disassociate product to execution path(s)

PATCH /product/v1/products/{id}/productExecutionPath
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Body

pathIds
required

pathIds

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

200

OK

object

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.13. Product-family-controller

Product Family Controller

2.13.1. Create Product Family

POST /product/v1/productFamilies
Parameters
Type Name Description Schema

Query

description
required

description

string
Responses
HTTP Code Description Schema

201

Created

ProductFamilyInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.13.2. Get product families

GET /product/v1/productFamilies
Parameters
Type Name Description Schema

Query

page
optional

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

integer (int32)

Query

productId
optional

productId

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductFamilyPage

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

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.13.3. Get product family by ID

GET /product/v1/productFamilies/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ProductFamily

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content

404

Not Found

No Content
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.13.4. Update Product Family

PUT /product/v1/productFamilies/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Query

description
required

description

string
Responses
HTTP Code Description Schema

200

OK

ProductFamilyInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.13.5. Delete Product Family By Id

DELETE /product/v1/productFamilies/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • /

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.14. Product-group-controller

Product Group Controller

2.14.1. Get product groups

GET /product/v1/productGroups
Parameters
Type Name Description Schema

Query

page
optional

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

integer (int32)

Query

productId
optional

productId

integer (int64)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

ProductGroupPage

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

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.14.2. Get product group by ID

GET /product/v1/productGroups/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

ProductGroup

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content

404

Not Found

No Content
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.15. Product-property-group-controller

Product Property Group Controller

2.15.1. Get property groups of product

GET /v1/globalProductPropertyGroups
Parameters
Type Name Description Schema

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

PropertyGroupPage

401

Unauthorized

No Content

500

Internal server error

No Content

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.15.2. Update property groups

PUT /v1/globalProductPropertyGroups
Parameters
Type Name Description Schema

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array
Responses
HTTP Code Description Schema

200

OK

ProductPropertyGroupInfo

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal server error

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.16. Product-property-value-controller

Product Property Value Controller

2.16.1. Get property value for product

GET /v1/products/{productId}/propertyValues
Parameters
Type Name Description Schema

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

PropertyValuePage

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

500

Internal server error

No Content

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.16.2. update property values

PUT /v1/products/{productId}/propertyValues
Parameters
Type Name Description Schema

Path

productId
required

product id

integer (int64)

Body

propertyDefinitionUpdateInfo
required

PropertyDefinitionUpdateInfo

< ProductPropertyDefinitionUpdateInfo > array
Responses
HTTP Code Description Schema

200

OK

< PropertyValue > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

No Content

404

Not Found

No Content

422

Unprocessible Entity

No Content

500

Internal Server Error

HttpErrorResponse

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.17. Product-unit-controller

Product Unit Controller

2.17.1. Get product units

GET /product/v1/productUnits
Parameters
Type Name Description Schema

Query

departmentIds
optional

departmentIds

string

Query

lineIds
optional

lineIds

string

Query

page
optional

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

integer (int32)

Query

productIds
optional

productIds

string

Query

size
optional

Number of records per page.

integer (int32)

Query

unitIds
optional

unitIds

string
Responses
HTTP Code Description Schema

200

OK

ProductUnitPage

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

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.17.2. Get product unit by ID

GET /product/v1/productUnits/{id}
Parameters
Type Name Description Schema

Path

id
required

id

string
Responses
HTTP Code Description Schema

200

OK

ProductUnit

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content

404

Not Found

No Content
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.17.3. Associate/Disassociate product to production unit(s)

PATCH /product/v1/products/{id}/productUnits
Parameters
Type Name Description Schema

Path

id
required

id

integer (int64)

Body

unitIds
required

unitIds

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

200

OK

object

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Consumes

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Produces

  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.18. Reallocation-operations-controller

Reallocation Operations Controller

2.18.1. Check originMaterialLotId is having single or multiple source lot

GET /checkMultipleSourceLots
Parameters
Type Name Description Schema

Query

bomItemId
optional

bomItemId

integer (int64)

Query

originMaterialLotId
optional

originMaterialLotId Lot Id

integer (int64)

Query

segmentId
optional

segmentId

integer (int64)

Query

workOrderId
optional

workOrderId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

boolean

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.18.2. Get Reallocation BOM Genealogy consumption records

GET /reallocation/genealogy
Parameters
Type Name Description Schema

Query

bomItemId
required

Consumption records for bomItemId.

integer (int64)

Query

segmentId
optional

Consumption records for segmentId.

integer (int64)

Query

sourceMaterialLotId
required

Source Material Reallocation Lot ID the product being consumed.

integer (int64)

Query

workOrderId
required

Consumption records for workOrderId.

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< ConsumedLotInfo > array

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.18.3. Reallocation Operations

POST /reallocationOperations
Parameters
Type Name Description Schema

Query

resourceId
optional

resourceId

integer (int32)

Query

resourceType
optional

resourceType

string

Body

reallocationOperationsRequest
required

reallocationOperationsRequest

ReallocationOperationsRequest
Responses
HTTP Code Description Schema

200

OK

ReallocationOperationsResponse

400

Invalid data supplied. See message for details.

No Content

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

No Content

422

Unprocessable Entity

No Content

503

Service Unavailable

No Content
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

2.19. Unit-engineering-unit-controller

Unit Engineering Unit Controller

2.19.1. Get Engineering unit associated to Unit id

GET /units/{unitId}/engineeringUnits
Parameters
Type Name Description Schema

Path

unitId
required

unitId

integer (int64)
Responses
HTTP Code Description Schema

200

OK

UnitEngineeringUnit

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

3. Definitions

3.1. BomFamily

Name Description Schema

description
optional

The BOM family’s description

string

id
optional

The unique Id of the BOM family

integer (int64)

links
optional

< Link > array

3.2. BomFamilyPage

Name Schema

content
optional

< BomFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.3. 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)

standardQuantity
optional

Quantity this formulation produces.

number (double)

uom
optional

Units of measure used in Quantity.

integer (int64)

3.4. BomFormulationForUpdate

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)

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)

standardQuantity
optional

Quantity this formulation produces.

number (double)

uom
optional

Units of measure used in Quantity.

integer (int64)

3.5. BomFormulationInfo

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

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)

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

Quantity Precision

integer (int32)

standardQuantity
optional

standard quantity

number (double)

uom
optional

Eng unit Id

integer (int64)

3.6. BomFormulationInfoResult

Name Description Schema

bomMasterId
optional

Bom formulation Master BOM Id.

integer (int32)

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

productIds
optional

Associated products with the formulation.

< integer (int64) > array

quantityPrecision
optional

Quantity Precision

integer (int32)

standardQuantity
optional

standard quantity

number (double)

uom
optional

Eng unit Id

integer (int64)

3.7. BomFormulationInfoResults

Name Schema

content
optional

< BomFormulationInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.8. BomFormulationItem

Name Description Schema

alias
optional

bom formulation item alias

string

id
optional

Bom Formulation Item id

integer (int64)

itemOrder
optional

BOM Formulation Order

integer (int64)

lowerTolerance
optional

Lower Tolerance

number (double)

lowerTolerancePrecision
optional

bom formulation item lower Tolerance Precision

integer (int32)

productId
optional

Product id

integer (int64)

quantity
optional

Quantity of a BOM Formulationss

number (double)

quantityPrecision
optional

bom formulation Quantity Precision

integer (int32)

scrapFactor
optional

bom formulation item scrap factor

number (double)

storageUnit
optional

Storage Unit - PU

integer (int64)

uom
optional

Eng Unit Id

integer (int64)

upperTolerance
optional

Upper Tolerance

number (double)

upperTolerancePrecision
optional

bom formulation item upper Tolerance Precision

integer (int32)

3.9. 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.10. BomFormulationItemForUpdate

Name Description Schema

alias
optional

bom formulation item alias

string

id
optional

bom formulation item id to update.

integer (int64)

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

Name Description Schema

alias
optional

bom formulation item alias

string

id
optional

Bom Formulation Item id

integer (int64)

itemOrder
optional

BOM Formulation Order

integer (int64)

links
optional

< Link > array

lowerTolerance
optional

Lower Tolerance

number (double)

lowerTolerancePrecision
optional

bom formulation item lower Tolerance Precision

integer (int32)

productId
optional

Product id

integer (int64)

quantity
optional

Quantity of a BOM Formulationss

number (double)

quantityPrecision
optional

bom formulation Quantity Precision

integer (int32)

scrapFactor
optional

bom formulation item scrap factor

number (double)

storageUnit
optional

Storage Unit - PU

integer (int64)

uom
optional

Eng Unit Id

integer (int64)

upperTolerance
optional

Upper Tolerance

number (double)

upperTolerancePrecision
optional

bom formulation item upper Tolerance Precision

integer (int32)

3.12. BomMaster

Name Description Schema

active
optional

boolean

bomFamilyId
optional

The BOM Family Id

integer (int32)

description
optional

The BOM description

string

id
optional

The unique Id of the BOM

integer (int64)

links
optional

< Link > array

3.13. BomMasterPage

Name Schema

content
optional

< BomMaster > array

links
optional

< Link > array

page
optional

PageMetadata

3.14. ConsumedLotInfo

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

entryOn
optional

Lot Entry On

string (date-time)

id
optional

Consumption Record ID / event component ID

integer (int64)

lotIdentifier
optional

Lot Identifier

string

productId
optional

Product ID / Applied Product ID

integer (int64)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

timeStamp
optional

Lot Timestamp

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

userId
optional

PA UserId

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.15. ConsumptionOperationRequest

Name Description Schema

bomItemId
optional

Bom item ID

integer (int64)

consumedQuantity
optional

Consumed quantity

number (double)

segmentId
optional

Segment ID

integer (int64)

targetMaterialLotId
optional

Target material lot ID

integer (int64)

unitOfMeasureId
optional

Unit of measureId ID

integer (int64)

workOrderId
optional

Work order ID

integer (int64)

3.16. ConsumptionRecord

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

id
optional

Consumption Record ID / event component ID

integer (int64)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.17. ConsumptionRecordInfo

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

entryOn
optional

Lot Entry On

string (date-time)

id
optional

Consumption Record ID / event component ID

integer (int64)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier

string

productId
optional

Product ID / Applied Product ID

integer (int64)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

timeStamp
optional

Lot Timestamp

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

userId
optional

PA UserId

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.18. ConsumptionRecordInfoPage

Name Schema

content
optional

< ConsumptionRecordInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.19. ConsumptionRecordRequest

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

unitOfMeasureId
optional

Unit of Measre ID

integer (int64)

workOrderId
optional

Work Order ID

integer (int64)

3.20. Error

Name Schema

code
optional

string

details
optional

object

3.21. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.22. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.23. MaterialLotCommandInfo

Create scrap production event.

Name Description Schema

quanity
optional

number (float)

reasonLevel1
optional

The value of reasonLevel1

integer (int64)

reasonLevel2
optional

The value of reasonLevel2

integer (int64)

reasonLevel3
optional

The value of reasonLevel3

integer (int64)

reasonLevel4
optional

The value of reasonLevel4

integer (int64)

statusId
optional

The value of status Id

integer (int64)

3.24. MaterialLotInfo

Name Description Schema

initialQuantity
optional

Initial Quantity of lot / Initial Dimension X

number (double)

lotIdentifier
optional

Lot Identifier / Event Num

string

productId
optional

Product ID / Applied Product ID

integer (int64)

statusId
optional

Lot status / Event Status

integer (int64)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

3.25. MaterialLotInfoResult

Name Description Schema

availableForConsumption
optional

Is Available For Consumption
Example : false

boolean

currentQuantity
optional

Current Quantity of lot / Final Dimension X

number (float)

id
optional

Material Lot ID / Event ID

integer (int64)

initialQuantity
optional

Initial Quantity of lot / Initial Dimension X

number (double)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier / Event Num

string

processOrderId
optional

ID of process order / pp_id

integer (int64)

productId
optional

Product ID / Applied Product ID

integer (int64)

statusId
optional

Lot status / Event Status

integer (int64)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

3.26. MaterialLotInfoResults

Name Schema

content
optional

< MaterialLotInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.27. MaterialLotOverrideQuantitiyRequest

Name Description Schema

existingCurrentQuantity
optional

Existing Current Quantity of lot / Final Dimension X

number (float)

existingInitialQuantity
optional

Existing Initial Quantity of lot / Initial Dimension X

number (double)

newCurrentQuantity
optional

New Current Quantity of lot / Final Dimension X

number (float)

newInitialQuantity
optional

New Initial Quantity of lot / Initial Dimension X

number (double)

3.28. MaterialLotOverrideQuantitiyResponseResult

Name Description Schema

currentQuantity
optional

Current Quantity of lot / Final Dimension X

number (float)

id
optional

Material Lot ID / Event ID

integer (int64)

initialQuantity
optional

Initial Quantity of lot / Initial Dimension X

number (double)

links
optional

< Link > array

3.29. MaterialLotPropertyGroupInfo

MaterialLot Property Groups Data Transfer Object

Name Schema

id
optional

string

3.30. MaterialLotPropertyResult

Name Description Schema

links
optional

< Link > array

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.31. MaterialLotPropertyResults

Name Schema

content
optional

< MaterialLotPropertyResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.32. MaterialLotStatus

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good
Example : false

boolean

isInventoryStatus
optional

Is Inventory
Example : false

boolean

isProductionStatus
optional

Is Production
Example : false

boolean

3.33. MaterialLotStatusResult

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good
Example : false

boolean

isInventoryStatus
optional

Is Inventory
Example : false

boolean

isProductionStatus
optional

Is Production
Example : false

boolean

links
optional

< Link > array

3.34. MaterialLotUpdateInfo

Name Description Schema

lotIdentifier
optional

Lot Identifier / event_num

string

statusId
optional

Lot status / event_status

integer (int64)

3.35. MaterialTraceabilityInfo

Name Description Schema

consumedQuantity
optional

Consumed Quantity

number (double)

id
optional

event Component Id

integer (int64)

links
optional

< Link > array

productId
optional

Product ID / Applied Product ID

integer (int64)

sourceLotIdentifier
optional

Source Lot Identifier/Event_Num

string

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

unitId
optional

Unit ID / PU ID

integer (int64)

3.36. MaterialTraceabilityRecord

Name Description Schema

consumedQuantity
optional

Consumed Quantity

number (double)

id
optional

event component ID

integer (int64)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

3.37. MaterialTraceabilityRecordInfoPage

Name Schema

content
optional

< MaterialTraceabilityInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.38. MaterialTraceabilityRequest

Name Description Schema

childUnitId
optional

Child UnitId

number (double)

consumedQuantity
optional

Consumed Quantity

number (double)

dimensionA
optional

Dimension A

number (double)

dimensionY
optional

Dimension Y

number (double)

dimensionZ
optional

Dimension Z

number (double)

extendedInfo
optional

extended_Info

string

pEIId
optional

PEI_Id

number (double)

parentComponentId
optional

parent Component Id

number (double)

reportAsConsumption
optional

ReportAsConsumption

number (double)

sendPost
optional

SendPost

number (double)

signatureId
optional

Signature_id

number (double)

sourceMaterialLotId
optional

Source Material Lot ID

integer (int64)

startCoordinateA
optional

Start_Coordinate_A

number (double)

startCoordinateX
optional

Start_coordinate _x

number (double)

startCoordinateY
optional

Start_coordinate _Y

number (double)

startCoordinateZ
optional

Start_Coordinate_Z

number (double)

targetMaterialLotId
optional

Target material Lot ID

integer (int64)

3.39. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.40. Product

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not
Example : false

boolean

links
optional

< Link > array

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

productGroupId
optional

The id of the product group this product is a member of

integer (int64)

3.41. ProductCreateInfo

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

isSerialized
optional

The product Id is serialized or not
Example : false

boolean

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

3.42. ProductExecutionPathInfo

Name Description Schema

id
optional

The unique Id of the product execution path products

integer (int64)

pathCode
optional

Path Code

string

pathDescription
optional

Path Description

string

plId
optional

PL Id

integer (int64)

3.43. ProductExecutionPathPage

Name Schema

content
optional

< ProductExecutionPathInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.44. ProductFamily

Name Description Schema

description
optional

The product family’s description

string

id
optional

The unique Id of the product family

integer (int64)

links
optional

< Link > array

3.45. ProductFamilyInfo

Name Description Schema

description
optional

The product family’s description

string

id
optional

The unique Id of the product family

integer (int64)

3.46. ProductFamilyPage

Name Schema

content
optional

< ProductFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.47. ProductGroup

Name Description Schema

description
optional

The property group’s description

string

links
optional

< Link > array

productGroupId
optional

The unique Id of the product group

integer (int64)

3.48. ProductGroupPage

Name Schema

content
optional

< ProductGroup > array

links
optional

< Link > array

page
optional

PageMetadata

3.49. ProductInfo

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not
Example : false

boolean

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

productGroupId
optional

The id of the product group this product is a member of

integer (int64)

3.50. ProductPage

Name Schema

content
optional

< Product > array

links
optional

< Link > array

page
optional

PageMetadata

3.51. ProductPropertyDefinitionUpdateInfo

Product Property Value Data Transfer Object

Name Description Schema

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.52. ProductPropertyGroupInfo

Product Property Groups Data Transfer Object

Name Schema

id
optional

string

3.53. ProductUnit

Name Description Schema

departmentId
optional

The ID of the department

integer (int64)

engUnitId
optional

The unique ID of the engineering unit

integer (int64)

lineId
optional

The ID of the department

integer (int64)

links
optional

< Link > array

productId
optional

The unique ID of the department

integer (int64)

productUnitId
optional

The ID of the production unit

string

unitId
optional

The ID of the unit

integer (int64)

3.54. ProductUnitPage

Name Schema

content
optional

< ProductUnit > array

links
optional

< Link > array

page
optional

PageMetadata

3.55. ProductUpdateInfo

Name Description Schema

code
optional

The product code

string

productFamilyId
optional

The id of the product family this product is a member of

integer (int64)

3.56. PropertyGroup

Name Schema

id
optional

string

links
optional

< Link > array

3.57. PropertyGroupPage

Name Schema

content
optional

< PropertyGroup > array

links
optional

< Link > array

page
optional

PageMetadata

3.58. PropertyValue

Name Description Schema

links
optional

< Link > array

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.59. PropertyValuePage

Name Schema

content
optional

< PropertyValue > array

links
optional

< Link > array

page
optional

PageMetadata

3.60. ReallocationOperationRequest

Name Description Schema

bomItemId
optional

Bom item ID

integer (int64)

consumptionOperations
optional

Consumption operations list

< ConsumptionOperationRequest > array

reallocatedQuantity
optional

Re allocated quantity

number (double)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source MaterialLot ID

integer (int64)

unitOfMeasureId
optional

Unit of measure ID

integer (int64)

3.61. ReallocationOperationResponse

Name Description Schema

bomItemId
optional

Bom item ID

integer (int64)

consumptionOperations
optional

Consumption operations list

< ConsumptionRecord > array

reallocatedQuantity
optional

Re allocated quantity

number (double)

segmentId
optional

Segment ID

integer (int64)

sourceMaterialLotId
optional

Source MaterialLot ID

integer (int64)

unitOfMeasureId
optional

Unit of measure ID

integer (int64)

3.62. ReallocationOperationsRequest

Name Description Schema

originMaterialLotId
optional

Target material lot ID

integer (int64)

reallocationOperations
optional

Reallocation operations list

< ReallocationOperationRequest > array

workOrderId
optional

Work order ID

integer (int64)

3.63. ReallocationOperationsResponse

Name Description Schema

originMaterialLotId
optional

Target material lot ID

integer (int64)

reallocationOperations
optional

Reallocation operations list

< ReallocationOperationResponse > array

workOrderId
optional

Work order ID

integer (int64)

3.64. UnitEngineeringUnit

Name Description Schema

engUnitId
optional

The unique ID of the engineering unit

integer (int64)

links
optional

< Link > array

unitId
optional

The ID of the unit

integer (int64)

3.65. UnitOfMeasure

Name Description Schema

active
optional

Active
Example : false

boolean

code
optional

Engineering Unit code

string

description
optional

Engineering Unit description

string

engUnitId
optional

Engineering Unit id

integer (int64)

links
optional

< Link > array

3.66. UnitOfMeasurePage

Name Schema

content
optional

< UnitOfMeasure > array

links
optional

< Link > array

page
optional

PageMetadata

4. Security

4.1. access_token

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

Name Description

mes.materiallot.create

Core service permissions to create material lot

mes.consumptionoperations.edit

Core service permission to create and edit consumption operations for raw material genealogy

4.2. resource_owner

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

Name Description

mes.materiallot.create

Core service permissions to create material lot

mes.consumptionoperations.edit

Core service permission to create and edit consumption operations for raw material genealogy

4.3. implicit_grant

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

Name Description

mes.materiallot.create

Core service permissions to create material lot

mes.consumptionoperations.edit

Core service permission to create and edit consumption operations for raw material genealogy

4.4. client_creds

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

Name Description

mes.materiallot.create

Core service permissions to create material lot

mes.consumptionoperations.edit

Core service permission to create and edit consumption operations for raw material genealogy

4.5. On-Behalf-Of

Type : apiKey
Name : On-Behalf-Of
In : HEADER