1. Overview

Microservice containing the business logic for managing product-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • assignment-lot-controller : Assignment Lot Controller

  • 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-lot-status-transition-controller : Material Lot Status Transition 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-global-group-controller : Product Property Global 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

  • variable-property-global-group-controller : Variable Property Global Group Controller

  • variable-property-value-controller : Variable Property Value Controller

2. Resources

2.1. Assignment-lot-controller

Assignment Lot Controller

2.1.1. Get assignments lots for a given work order id.

GET /api/v1/lotAssignments
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

workOrderId
required

Work order id of the assignment

integer (int64)
Responses
HTTP Code Description Schema

200

Ok

< AssignmentLotInfo > 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.1.2. Create Assignments

POST /api/v1/lotAssignments/assignments
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

assignmentDocumentObj
required

Details of the Assignments.

Assignments
Responses
HTTP Code Description Schema

200

Ok

Assignments

400

Bad Request

No Content

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.2. Bom-family-controller

Bom Family Controller

2.2.1. Get All BOM Families

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

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.2.2. Create BOM family

POST /bomFamilies/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

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.2.3. Get BOM Family by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3. Bom-formulation-controller

Bom Formulation Controller

2.3.1. Create BOM Formulation

POST /formulations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.2. Get BOM Formulations

GET /formulations
Parameters
Type Name Description Schema

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)

Query

status
optional

status

string
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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.3. Search Impacted BOMFomrulations Based on materialids

PATCH /formulations/impactedBomFormualtions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

materialIds
required

material Ids

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

200

Ok

< ImpactedBomFormulation > array

400

Invalid data supplied. See message for details.

No Content

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.4. Get BOM Formulation Item by Id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.5. Get property values for bom formulation item

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

bom formulation item 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

BomFormulationItemPropertyResults

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.6. Create BOM Formulation Items Substitutions

POST /formulations/items/{formulationItemId}/substitutions
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

Bom formulation item id to create bom substitutions.

integer (int64)

Body

bomItemSubstitution
required

Details on the Bom Substitution item to create.

BomItemSubstitutionForCreate
Responses
HTTP Code Description Schema

201

Success

BomItemSubstitutionForCreate

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.7. Get Bom substitutions for bom formulation item

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

bom formulation item id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

< BomSubstitutionsItem > array

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.8. Update BOM Formulation Items Substitutions

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

Bom formulationItem Id to update.

integer (int64)

Path

substitutionId
required

Bom formulation Substitution id to update.

integer (int64)

Body

bomItemSubstitution
required

Details on the bom Substitution item to update.

BomItemSubstitutionForCreate
Responses
HTTP Code Description Schema

200

Success

BomItemSubstitutionForCreate

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.9. Delete BOM Substitutions

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationItemId
required

formulationItemId

integer (int64)

Path

substitutionId
required

substitutionId of the BOM substitution 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.10. Get BOM Formulation by Id

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.11. Update BOM Formulation

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.12. Delete BOM Formulation

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.13. Archive BOM formulation

PATCH /formulations/{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

Invalid data supplied. See message for details.

No Content

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.14. Create BOM Formulation Items

POST /formulations/{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 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.15. Get BOM items by BOM formulationId

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

< 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.16. Update BOM Formulation Items

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.17. Delete BOM Formulation Item

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.18. Update BOM Formulation Item Property

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulationId of the BOM Formulation item property to be updated.

integer (int64)

Path

formulationItemId
required

formulation Item Id of the BOM Formulation item property to be updated.

integer (int64)

Body

propertyDefinitionInfo
required

Details on the bom formulation item property to update.

< ProductPropertyDefinitionUpdateInfo > array
Responses
HTTP Code Description Schema

200

Success

< BomFormulationPropertyDefinitionInfo > 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
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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.19. Update Specific BOM Formulation Item Property Value

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulationId of the BOM Formulation Item property to be updated.

integer (int64)

Path

formulationItemId
required

formulationId of the BOM Formulation Item property to be updated.

integer (int64)

Path

propertyDefinitionId
required

propertyDefinitionId whose value which needs to be added/updated.

string

Body

propertyDefinitionValueInfo
required

Details of the property definition value to add/update.

PropertyDefinitionUpdateInfo
Responses
HTTP Code Description Schema

200

Success

BomFormulationPropertyDefinitionInfo

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.20. Get property values for bom formulation

GET /formulations/{formulationId}/propertyValues
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)

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

BomFormulationPropertyResults

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.21. Update BOM Formulation Property

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

formulationId
required

formulationId of the BOM Formulation property to be updated.

integer (int64)

Body

propertyDefinitionInfo
required

Details on the bom formulation property to update.

< ProductPropertyDefinitionUpdateInfo > array
Responses
HTTP Code Description Schema

200

Success

< BomFormulationPropertyDefinitionInfo > 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
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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.22. Release a BOM formulation

POST /formulations/{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

Invalid data supplied. See message for details.

No Content

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

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.3.23. Create BOM Formulation revision

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

bomFormulationRequestForRevision
required

BOM formulation revision creation details

BomFormulationForRevision
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

Un-processable Entity

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.4. Bom-master-controller

Bom Master Controller

2.4.1. Create BOM Master

POST /bomMasters
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

bomMasterRequest
required

bomMasterRequest

BomMasterRequest
Responses
HTTP Code Description Schema

201

Created

BomMasterResponse

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.4.2. Get All BOM Masters

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

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.4.3. Get BOM Master by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.5. Consumption-operations-controller

Consumption Operations Controller

2.5.1. Create a consumption or return record. For return, provide the consumedQuantity field value as negative in the request body. Also if you want to change the status of the lot during return, then you can utilise returnLotStatusId field.

POST /consumptionOperations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.5.2. Get Consumption lots

GET /consumptionOperations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.6. Engineering-units-controller

Engineering Units Controller

2.6.1. Create new uom (engineering units)

POST /engineeringUnits
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

engineeringUnitReq
required

engineeringUnitReq

EngineeringUnitForCreate
Responses
HTTP Code Description Schema

201

Created

UnitOfMeasure

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.6.2. Get all uom (engineering units)

GET /engineeringUnits
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.6.3. Get uom (an engineering unit)

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.6.4. Update uom (engineering units)

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

engineeringUnitId
required

Engineering Unit Id

integer (int64)

Body

engineeringUnitUpdateInfo
required

engineeringUnitUpdateInfo

EngineeringUnitForUpdate
Responses
HTTP Code Description Schema

200

OK

UnitOfMeasure

401

Unauthorized

HttpErrorResponse

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.6.5. Delete uom (engineering units) By Id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

engineeringUnitId
required

Engineering Unit 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.7. Material-lot-command-controller

Material Lot Command Controller

2.7.1. Create scrap producton event

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8. Material-lot-controller

Material Lot Controller

2.8.1. Create a material lot

POST /materialLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.2. Get list of materialLots and their properties

GET /materialLots
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

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 includes implicit products.

boolean

"false"

Query

lotIdentifier
optional

lot identifier (use lot_identifier/event_num for this property)

string

Query

lotIdentifierPartialSearch
optional

Whether to do partial match using lotIdentifier param or exact match. Default value false - lotIdentifier param will be used for exact match to Event_Num or lot_Identifier. True - lotIdentifier param will be used for partial match to Event_Num or lot_Identifier

boolean

"false"

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

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.3. Update bulk material lots

PUT /materialLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

materialLotUpdateInfoList
required

materialLotUpdateInfoList

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.4. Generate Material Lot Identifiers

POST /materialLots/generateMaterialLotIdentifiers
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

generateMaterialLotIdentifierInfo
required

generateMaterialLotIdentifierInfo

GenerateMaterialLotIdentifierInfo
Responses
HTTP Code Description Schema

201

Created

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
Consumes

  • application/json

Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.5. Get list of materialLots properties

GET /materialLots/materialLotProperties
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

Comma separated materialLot ids
required

Comma separated materialLot ids

string
Responses
HTTP Code Description Schema

200

OK

< MaterialLotPropertyDefinitionInfo > array

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.6. Get the specific materialLot by materialLotId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.7. Update a material lot

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.8. Update Material lot Override quantities

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.9. Get list of materialLots properties

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.8.10. update materiallot property values

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.9. Material-lot-property-group-controller

Material Lot Property Group Controller

2.9.1. Get property groups of material lot

GET /v1/globalMaterialLotPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

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

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.9.2. Update material lot property groups

PUT /v1/globalMaterialLotPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.10. Material-lot-status-controller

Material Lot Status Controller

2.10.1. Get All MaterialLot Statuses

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

< 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.10.2. Get MaterialLot Status by materialLotStatusId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.11. Material-lot-status-transition-controller

Material Lot Status Transition Controller

2.11.1. Get MaterialLot Status transitions for a given material lot id

GET /api/v1/material-lot-status-transitions/{materialLotId}
Parameters
Type Name Description Schema Default

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

materialLotId
required

Id of the material lot whose status transitions are required

integer (int64)

Query

orderBy
optional

Name of the property to sort the results by

enum (asc, desc)

"desc"

Query

orderByColumn
optional

Name of the column to sort the results

string

"start_time"
Responses
HTTP Code Description Schema

200

Ok

< MaterialLotStatusTransition > 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.12. Material-traceability-controller

Material Traceability Controller

2.12.1. Create Material Traceability Record

POST /materialTraceabilityRecords
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.12.2. Get MaterialTraceability Record

GET /materialTraceabilityRecords
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13. Product-controller

Product Controller

2.13.1. Create Product

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13.2. Get products

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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)

0

Query

productFamilyIds
optional

productFamilyIds

string

Query

productGroupIds
optional

productGroupIds

string

Query

size
optional

Number of records per page.

integer (int32)

20

Query

unitIds
optional

Unit Ids of Product.

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

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13.3. Get products By productCode

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

productCode
optional

productCode

string
Responses
HTTP Code Description Schema

200

OK

object

400

BadRequest

No Content

401

Unauthorized

No Content

403

Forbidden, Authenticated user is not known by MES

No Content
Produces

  • application/json;charset=utf-8

Security
Type Name Scopes

oauth2

access_token

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13.4. Get product by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13.5. Update Product

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.13.6. Delete Product By Id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.14. Product-execution-path-controller

Product Execution Path Controller

2.14.1. Get product execution paths

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

Header

Site-Id
required

Represents the id of the site to connect to

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

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.14.2. Get active product execution paths for given productId

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

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

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15. Product-family-controller

Product Family Controller

2.15.1. Create Product Family

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.2. Get product families

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.3. Get List of security groups

GET /product/v1/productFamilies/getsecuritygroups
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

SecurityGroups

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.4. Get product family by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.5. Update Product Family

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.6. Delete Product Family By Id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

object

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.15.7. Update Product Family Security

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

Path

securityGroupId
required

securityGroupId

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.16. Product-group-controller

Product Group Controller

2.16.1. Get product groups

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.16.2. Get product group by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)
Responses
HTTP Code Description Schema

200

OK

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.17. Product-property-global-group-controller

Product Property Global Group Controller

2.17.1. Get global property groups associated to product

GET /v1/globalProductPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

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

PropertyGroupValuePage

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.17.2. Associate global property groups to product entity

PUT /v1/globalProductPropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array
Responses
HTTP Code Description Schema

200

OK

< ProductPropertyGroupInfoResult > array

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.17.3. Get product global property groups by group Id

GET /v1/globalProductPropertyGroups/{groupID}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

groupID
required

groupID

string
Responses
HTTP Code Description Schema

200

OK

ProductPropertyGroupInfo

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.17.4. Delete global property groups entity associate

DELETE /v1/globalProductPropertyGroups/{groupID}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

groupID
required

groupID

string
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.18. Product-property-value-controller

Product Property Value Controller

2.18.1. Get property value for product

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

product id

integer (int64)

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.18.2. update property values

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

productId
required

product id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.19. Product-unit-controller

Product Unit Controller

2.19.1. Get product units

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.19.2. Get product unit by ID

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

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

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

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

id
required

id

integer (int64)

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.20. Reallocation-operations-controller

Reallocation Operations Controller

2.20.1. Check originMaterialLotId is having single or multiple source lot

GET /checkMultipleSourceLots
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.20.2. Get Reallocation BOM Genealogy consumption records

GET /reallocation/genealogy
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.20.3. Reallocation Operations

POST /reallocationOperations
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.21. Unit-engineering-unit-controller

Unit Engineering Unit Controller

2.21.1. Get Engineering unit associated to Unit id

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

Header

Site-Id
required

Represents the id of the site to connect to

string

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.22. Variable-property-global-group-controller

Variable Property Global Group Controller

2.22.1. Get global property groups associated to variable

GET /v1/globalVariablePropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

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

VariablePropertyGroupValuePage

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.22.2. Associate global property groups to material/work unit entities

PUT /v1/globalVariablePropertyGroups
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Query

groupType
required

groupType

enum (MATERIAL, WORK_UNIT_TYPE)

Body

propertyGroupUpdateInfo
required

Property Group Ids

< string > array
Responses
HTTP Code Description Schema

200

OK

< VariablePropertyGroupInfoResult > array

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.22.3. Get variable global property groups by group Id

GET /v1/globalVariablePropertyGroups/{groupID}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

groupID
required

groupID

string

Query

groupType
required

groupType

enum (MATERIAL, WORK_UNIT_TYPE)
Responses
HTTP Code Description Schema

200

OK

VariablePropertyGroupInfo

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.22.4. Delete global property groups entity associate

DELETE /v1/globalVariablePropertyGroups/{groupID}
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

groupID
required

groupID

string

Query

groupType
required

groupType

enum (MATERIAL, WORK_UNIT_TYPE)
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Property Group with that name already exists

HttpErrorResponse

412

Property Group has been updated since the GET on which the submitted changes were made. Response contains the current record.

HttpErrorResponse

500

Internal Server error

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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.23. Variable-property-value-controller

Variable Property Value Controller

2.23.1. Get property value for variable

GET /v1/variables/{variableId}/propertyValues
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

variableId
required

variable 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

2.23.2. update variable property values

PUT /v1/variables/{variableId}/propertyValues
Parameters
Type Name Description Schema

Header

Site-Id
required

Represents the id of the site to connect to

string

Path

variableId
required

product id

integer (int64)

Body

propertyDefinitionUpdateInfo
required

PropertyDefinitionUpdateInfo

< VariablePropertyDefinitionUpdateInfo > 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

resource_owner

mes.materiallot.create,mes.consumptionoperations.edit

apiKey

On-Behalf-Of

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

implicit_grant

mes.materiallot.create,mes.consumptionoperations.edit

oauth2

client_creds

mes.materiallot.create,mes.consumptionoperations.edit

3. Definitions

3.1. AssignmentLotInfo

Name Description Schema

assignmentDocument
optional

The assignment lot json document associated with the work order

string

workOrderId
optional

The work order id

integer (int64)

workOrderName
optional

The work order name

string

3.2. Assignments

Name Description Schema

lotAssignment
optional

List of Lot Assignments

< LotAssignment > array

schemaVersion
optional

Assignment Schema Version.

integer (int32)

targetMaterialLot
optional

Target Lot Name

string

workOrder
optional

Work Order Name

string

3.3. BomApprovalRequest

Approval process request associated with BOM release

Name Description Schema

workFlowId
optional

Approval process workflow id.

integer (int64)

3.4. 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.5. BomFamilyCreateInfo

Name Description Schema

description
optional

The BOM family’s description

string

3.6. BomFamilyInfo

Name Description Schema

description
optional

The BOM family’s description

string

id
optional

The unique Id of the BOM family

integer (int64)

3.7. BomFamilyPage

Name Schema

content
optional

< BomFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.8. 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.9. 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.10. 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.11. BomFormulationInfo

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)

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.12. 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.13. BomFormulationInfoResults

Name Schema

content
optional

< BomFormulationInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.14. 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.15. 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.16. 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.17. BomFormulationItemPropertyResult

Name Description Schema

formulationItemId
required

The id of the bom formulation

integer (int64)

links
optional

< Link > array

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.18. BomFormulationItemPropertyResults

Name Schema

content
optional

< BomFormulationItemPropertyResult > array

links
optional

< Link > array

page
optional

PageMetadata

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

Bom Formulation Property Value Data Transfer Object

Name Description Schema

formulationId
required

The id of the bom formulation

integer (int64)

formulationItemId
required

The id of the bom formulation

integer (int64)

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.21. BomFormulationPropertyResult

Name Description Schema

formulationId
required

The id of the bom formulation

integer (int64)

links
optional

< Link > array

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.22. BomFormulationPropertyResults

Name Schema

content
optional

< BomFormulationPropertyResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.23. BomFormulationRequestForArchive

Request object for archiving a BOM formulation

Name Description Schema

status
required

Status of the BOM formulation

string

3.24. BomItemSubstitutionForCreate

Name Schema

bomFormulationItemId
optional
read-only

integer (int64)

bomSubstitutionOrder
optional

integer (int32)

conversionFactor
optional

number (double)

engUnitId
optional

integer (int32)

productId
optional

integer (int32)

substitutionId
optional
read-only

integer (int64)

3.25. 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.26. BomMasterPage

Name Schema

content
optional

< BomMaster > array

links
optional

< Link > array

page
optional

PageMetadata

3.27. BomMasterRequest

Name Description Schema

description
optional

Description

string

familyId
optional

Family Id

integer (int32)

3.28. BomMasterResponse

Name Description Schema

description
optional

The BOM Master description

string

id
optional

The unique Id of the BOM Master

integer (int64)

3.29. BomSubstitutionsItem

Name Description Schema

bomItemid
optional

Bom Formulation Item Id

integer (int64)

bomSubstitutionOrder
optional

Bom Substitution Order

integer (int32)

conversionFactor
optional

Bom Substitution Conversion Factor

number (double)

productId
optional

Product Id

integer (int64)

substitutionId
optional

substitution Id Value

integer (int64)

uom
optional

Eng Unit Id

integer (int64)

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

finalQuantity
optional

Final lot quantity

number (float)

id
optional

Consumption Record ID / event component ID

integer (int64)

initialQuantity
optional

Initial lot quantity

number (float)

lotIdentifier
optional

Lot Identifier

string

lotStatus
optional

Lot status

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.31. 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.32. 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.33. 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)

finalQuantity
optional

Final lot quantity

number (float)

id
optional

Consumption Record ID / event component ID

integer (int64)

initialQuantity
optional

Initial lot quantity

number (float)

links
optional

< Link > array

lotIdentifier
optional

Lot Identifier

string

lotStatus
optional

Lot status

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.34. ConsumptionRecordInfoPage

Name Schema

content
optional

< ConsumptionRecordInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.35. ConsumptionRecordRequest

Name Description Schema

bomItemId
optional

Bom Item ID

integer (int64)

consumedQuantity
optional

Consumed Quantity

number (double)

returnLotStatusId
optional

Lot status for the return lot

integer (int32)

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.36. DimensionalQuantity

Name Description Schema

currentQuantity
optional

Current Quantity of lot / Final Dimension

number (float)

dimension
optional

Dimension to which to which it belongs

string

dimensionName
optional

Dimension name of Subtype

string

initialQuantity
optional

Initial Quantity of lot for / Initial Dimension

number (double)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

3.37. EngineeringUnitForCreate

Name Description Schema

code
required

Engineering Unit code

string

description
required

Engineering Unit description

string

3.38. EngineeringUnitForUpdate

Name Description Schema

code
required

Engineering Unit code

string

description
required

Engineering Unit description

string

id
required

Engineering Unit id to update

integer (int64)

3.39. Error

Name Schema

code
optional

string

details
optional

object

3.40. GenerateMaterialLotIdentifierInfo

Name Description Schema

materialLotCount
required

Number of material lots to be generated.

integer (int32)

productId
required

Product Id.

integer (int64)

3.41. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.42. ImpactedBomFormulation

Name Schema

bomFomrulationDesc
optional

string

bomFormulationId
optional

integer (int64)

revision
optional

integer (int32)

status
optional

string

3.43. 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.44. LotAssignment

Name Description Schema

assignedLots
optional

List of assigned Lots

< assigned lots > array

bomItemAlias
optional

Bom Item Alias Name.

string

operations
optional

List of operations

< string > array

3.45. MaterialLotBulkUpdateInfo

Name Description Schema

lotIdentifier
optional

Lot Identifier / event_num

string

materialLotId
optional

Material Lot Id

integer (int64)

propertyDefinitionUpdateInfo
optional

Property Values of a product

< ProductPropertyDefinitionUpdateInfo > array

statusId
optional

Lot status / event_status

integer (int64)

3.46. 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.47. 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.48. MaterialLotInfoResult

Name Description Schema

availableForConsumption
optional

Is Available For Consumption

boolean

currentQuantity
optional

Current Quantity of lot / Final Dimension X

number (float)

dimension
optional

Dimension to which to which it belongs

string

dimensionName
optional

Dimension name of Subtype

string

dimensionalQuantities
optional

Collection of Dimensional quantities A,X,Y,Z

< DimensionalQuantity > array

extendedInfo
optional

Extended Information Receiver/OSP

string

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)

timeStamp
optional

Time when the lot was created.

string (date-time)

unitId
optional

Unit ID / PU ID

integer (int64)

unitOfMeasureId
optional

Unit Of Measure ID

integer (int64)

userId
optional

UserId of the user who created the lot.

integer (int64)

3.49. MaterialLotInfoResults

Name Schema

content
optional

< MaterialLotInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.50. 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.51. 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.52. MaterialLotPropertyDefinitionInfo

Material Lot Property Value Data Transfer Object

Name Description Schema

materialLotId
optional

The id of the Material Lot

integer (int64)

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.53. MaterialLotPropertyGroupInfo

MaterialLot Property Groups Data Transfer Object

Name Schema

id
optional

string

3.54. MaterialLotPropertyResult

Name Description Schema

links
optional

< Link > array

materialLotId
optional

The id of the Material Lot

integer (int64)

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.55. MaterialLotPropertyResults

Name Schema

content
optional

< MaterialLotPropertyResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.56. MaterialLotStatus

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good

boolean

isInventoryStatus
optional

Is Inventory

boolean

isProductionStatus
optional

Is Production

boolean

3.57. MaterialLotStatusResult

Name Description Schema

description
optional

MaterialLot Status Description

string

id
optional

MaterialLot Status ID / Event Status

integer (int64)

isGoodStatus
optional

Is Quality Good

boolean

isInventoryStatus
optional

Is Inventory

boolean

isProductionStatus
optional

Is Production

boolean

links
optional

< Link > array

3.58. MaterialLotStatusTransition

Name Description Schema

endTime
optional

End time of material lot status transition

string (date-time)

eventId
optional

MaterialLot Id / Event Id

integer (int32)

eventStatusId
optional

MaterialLot production status Id

integer (int32)

eventTransitionId
optional

Event status transition Id

integer (int32)

startTime
optional

Start time of material lot status transition

string (date-time)

unitId
optional

MaterialLot unit id

integer (int32)

3.59. MaterialLotUpdateInfo

Name Description Schema

lotIdentifier
optional

Lot Identifier / event_num

string

statusId
optional

Lot status / event_status

integer (int64)

3.60. 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.61. 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.62. MaterialTraceabilityRecordInfoPage

Name Schema

content
optional

< MaterialTraceabilityInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.63. 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.64. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.65. Product

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not

boolean

links
optional

< Link > array

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

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.66. ProductCreateInfo

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

isSerialized
optional

The product Id is serialized or not

boolean

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

productFamilyId
optional

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

integer (int64)

3.67. ProductExecutionPath

Name Description Schema

id
optional

The unique Id of the product execution path products

integer (int64)

links
optional

< Link > array

pathCode
optional

Path Code

string

pathDescription
optional

Path Description

string

plId
optional

PL Id

integer (int64)

3.68. 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.69. ProductExecutionPathPage

Name Schema

content
optional

< ProductExecutionPathInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.70. 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.71. ProductFamilyInfo

Name Description Schema

description
optional

The product family’s description

string

id
optional

The unique Id of the product family

integer (int64)

3.72. ProductFamilyPage

Name Schema

content
optional

< ProductFamily > array

links
optional

< Link > array

page
optional

PageMetadata

3.73. 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.74. ProductGroupPage

Name Schema

content
optional

< ProductGroup > array

links
optional

< Link > array

page
optional

PageMetadata

3.75. ProductInfo

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

id
optional

The unique ID of the product

integer (int64)

isSerialized
optional

The product Id is serialized or not

boolean

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

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.76. ProductPage

Name Schema

content
optional

< Product > array

links
optional

< Link > array

page
optional

PageMetadata

3.77. 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.78. ProductPropertyGroupInfo

Product Property Groups Data Transfer Object

Name Description Schema

createdBy
optional

Associated By

string

createdOn
optional

Associated on

string (date-time)

id
optional

string

propertyGroupId
optional

The unique ID of the property group

string

3.79. ProductPropertyGroupInfoResult

Name Description Schema

createdBy
optional

Associated By

string

createdOn
optional

Associated on

string (date-time)

id
optional

string

links
optional

< Link > array

propertyGroupId
optional

The unique ID of the property group

string

3.80. 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.81. ProductUnitPage

Name Schema

content
optional

< ProductUnit > array

links
optional

< Link > array

page
optional

PageMetadata

3.82. ProductUpdateInfo

Name Description Schema

code
optional

The product code

string

description
optional

The description of the product

string

descriptionGlobal
optional

The description of the product global

string

eventEsignatureLevel
optional

The event Esiganature level

integer (int64)

externalLink
optional

Product External Link

string

externalRevision
optional

The external revision

integer (int64)

productChangeEsignatureLevel
optional

The product change Esiganature level

integer (int64)

productFamilyId
optional

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

integer (int64)

3.83. PropertyDefinitionUpdateInfo

Property Definition Value Data Transfer Object

Name Description Schema

propertyValue
required

The value of the property

string

3.84. PropertyGroup

Name Schema

id
optional

string

links
optional

< Link > array

propertyGroupId
optional

string

3.85. PropertyGroupPage

Name Schema

id
optional

string

links
optional

< Link > array

propertyGroupId
optional

string

3.86. PropertyGroupValuePage

Name Schema

content
optional

< ProductPropertyGroupInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.87. PropertyValue

Name Description Schema

links
optional

< Link > array

materialLotId
optional

The id of the Material Lot

integer (int64)

propertyDefinitionId
required

The id of the property

string

propertyValue
required

The value of the property

string

3.88. PropertyValuePage

Name Schema

content
optional

< PropertyValue > array

links
optional

< Link > array

page
optional

PageMetadata

3.89. 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.90. 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.91. 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.92. 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.93. SecurityGroups

Name Schema

groupDesc
optional

string

groupId
optional

integer (int64)

3.94. TemplateVariable

Name Schema

description
optional

string

name
optional

string

type
optional

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

3.95. TemplateVariables

Type : object

3.96. 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.97. UnitOfMeasure

Name Description Schema

active
optional

Active

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.98. UnitOfMeasurePage

Name Schema

content
optional

< UnitOfMeasure > array

links
optional

< Link > array

page
optional

PageMetadata

3.99. UriTemplate

Name Schema

variableNames
optional

< string > array

variables
optional

TemplateVariables

3.100. VariablePropertyDefinitionUpdateInfo

Variable 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.101. VariablePropertyGroupInfo

Variable Property Groups Data Transfer Object

Name Description Schema

createdBy
optional

Associated By

string

createdOn
optional

Associated on

string (date-time)

groupType
optional

Group Type

integer (int32)

id
optional

string

propertyGroupId
optional

The unique ID of the property group

string

3.102. VariablePropertyGroupInfoResult

Name Description Schema

createdBy
optional

Associated By

string

createdOn
optional

Associated on

string (date-time)

groupType
optional

Group Type

integer (int32)

id
optional

string

links
optional

< Link > array

propertyGroupId
optional

The unique ID of the property group

string

3.103. VariablePropertyGroupValuePage

Name Schema

content
optional

< VariablePropertyGroupInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.104. assigned lots

Name Description Schema

material
optional

Product Name

string

name
optional

Assigned Lot name

string

quantity
optional

quantity

number (double)

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : https://localhost/uaa/oauth/authorize
Token URL : https://localhost/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/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/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/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