Developer Notes

MBSE SDK Server Bootstrap Package v/s OIM version compatibility matrix

SDK Server	OIM	Remarks
1.6.0	>=7.238	Updated 'Get elements at revision' API to POST method with request body and updated response structure Made elementTypeIds parameter optional in Revision Diff API
1.5.0	>=7.237 and <7.238	Added support for Project as an entity type
1.4.0	>=7.226 and <7.237	Added rich text support for Documentation Field Added filtering based on MetaType and identifiedStereotypes in the Owning Package field
1.3.0	>=7.224 and <7.226	Added support for query-based filtering using name and GUID. Redesigned the Element Types JSON configuration for improved structure and flexibility. Enabled support for polling entities from the first revision. Added support for Item Flow and reference fields.
1.2.0	>=7.218 and <7.224	Support for Generalization and Usage relationship, along with renaming of realization relationship
1.1.0	>=7.218 and <7.224	Batching and parallel processing implemented for getting list of elements on latest state and at given revision.
1.0.0	>=7.218 and <7.224	Initial Version. OIM supports MBSE SDK connector registration from 7.218 onwards.

---

Developer Notes

MBSE SDK Release 1.6.0

Breaking API changes

• Updated the Get elements at revision API:

  • Changed HTTP method from GET to POST (/mbse/api/1.0/revisions/{revisionId}/elements).

  • Added elementTypeIds as a mandatory query parameter.

  • Added a JSON request body containing the list of elements (elementId and changeType) whose state is to be retrieved.

  • Updated the response structure: each item now wraps the MBSE element with elementResolverId and mbseElement.

Backward Compatible Changes

• In the Revision Diff API (/mbse/api/1.0/revisions/diff), the elementTypeIds parameter is now optional.If the end system does not support filtering by element type, OIM will handle the filtering.

MBSE SDK Release 1.5.0

Backward Compatible Changes

• Added support for Project as an entity type

MBSE SDK Release 1.4.0

Backward Compatible Changes

• Added Rich Text Support in 'Documentation' Field

• Added filtering based on MetaType and identifiedStereotypes in the 'Owning Package' field

MBSE SDK Release 1.3.0

Backward Compatible Changes

• Added support for query-based filtering using name and GUID.

• Redesigned the element types json configuration for improved structure and flexibily.

• Enabled support for polling entities from first revision.

• Added support for item flow and reference fields.

Breaking API changes

• Added parameters for the branchName and branchDescription in the EmfBranchClient.

• Added deleteElements and bulkUpsertElements method in the EmfElementClient.

MBSE SDK Release 1.2.0

Backward Compatible Changes

• Added support for Generalization and Usage Relationship.

• Renaming for the realization link

MBSE SDK Release 1.1.0

Backward Compatible Changes

• Added support for Java 25.

• Batching and parallel processing implemented for 'Get elements at revision' and 'Get elements' methods.

MBSE SDK Release 1.0.0

First Release of MBSE SDK Server Bootstrap Package