Migration Path

This guide will provide some extra details on what to do in order to update your BMS API version.

Migrating from V1 to V2

Required

• Make sure to update the 'api-version' request header on all requests to "V2".
• Note: If your application expects a number/index value for the mixstate, please update this to a string based value.

Summary of changes:

New

A WorkOrder response now contains a new field to create, update and get: ApprovedAmount

Changed

The state field in a mixReference changed from number/index based values to string based values.

Removed

• Removed Id field in the update work order request
• Removed CreatedBy field in the update work order request
• Removed responseBody query parameter in create work order request

Migrating from V2 to V3

Required

• Make sure to update the 'api-version' request header on all requests to "V3".
• Note: If your application tries to read data from the mixingRoom, make sure to specify which property from the mixingRoom object you want to select.

Summary of changes:

New

A WorkOrder response will now contain mixReferences with a materialNumber property in its components.

Changed

A WorkOrder response will now contain a mixingRoom object rather than mixingRoom being an id (string value). The mixingRoom object contains the id (which was already available in V2) and also contains a new property "name".