Developer Notes

SDK Server Bootstrap Package v/s OIM version compatibility matrix

SDK Server	OIM	Remarks
1.17.0	>=7.198	Added support for bulk linking and link ordering
1.16.0	>=7.197 and <7.198	Added support for systemId to store system-specific cache and cleanupGlobalCache flag to control cache cleanup. Added support for adding multiple inline url prefix.
1.15.0	>=7.189 and <7.197	Added support for Rank synchronization
1.14.0	>=7.188 and <7.189	Added support for attachment file comment.
1.13.0	>=7.184 and <7.188	Added support for forming Remote Link using different base URL.
1.12.0	>=7.182 and <7.184	Added support for 'fetch mapped data only' feature.
1.11.0	>=7.179 and <7.182	Added Support for entity type and project movement. Added provision for filtering comments after specified time.
1.10.0	>=7.177 and <7.179	Optimized Entity-List API
1.9.0	>=7.174 and <7.177	Added support for UserMention and EntityMention for MarkDown datatype and introduced support for subStepNumber in updateEntity.
1.8.0	>=7.168 and <7.174	Added support for Dynamic Retrieval of lookup fields in integration advance setting screens.
1.7.0	>=7.165 and <7.168	Added support for searching Entity Mention and User Mention in field or comment of HTML type using regex.
1.6.0	>=7.162 and <7.165	Added support for reference fields and upgraded spring boot version to 3.2.3
1.5.0	>=7.158 and <7.162	Project Structure Change with respect to code organization
1.4.0	>=7.156 and <7.158	Added support for Comment Author Impersonation
1.3.0	>=7.153 and <7.156	Added support for Next Page based Pagination
1.2.0	>=7.147	Added support for Non Time-Stamp based poller and Entity-Mention synchronization
1.1.0	>=7.140 and <7.147	Added support for delete sync
1.0.0	>=7.129 and <7.140	Initial Version. OIM supports SDK connector registration from 7.129 onwards.

---

Developer Notes

💡 Looking for older developer notes? Check out the Developer Notes for versions prior to 1.6.0.

SDK Release 1.17.0

Added support for bulk linking and link ordering

Breaking Changes

• Link Create or Update API

  • Request payload has been enhanced to support adding multiple links for a given link type, and ordering in a single API call.

• Link Delete API

  • Request payload has been enhanced to support deleting multiple links for a given link type in a single API call.

Backward Compatible Changes

• Entity Type-Get API

  • In Response Structure:

    • In links.linkTypes, attribute isBulkLinkingSupported is added.

    • In links.rank.supportedRankOperations, MOVE_BULK_AFTER is added.

---

SDK Release 1.16.0

Added support for systemId to store system-specific cache and cleanupGlobalCache flag to control cache cleanup.

Backward Compatible Changes

• Session Initialize API

  • In URI Parameters:

    • Added query parameter of the systemId.

• Session Logout API

  • In URI Parameters:

    • Added query parameter of the systemId.

    • Added query parameter of the cleanupGlobalCache.

Added support for adding multiple inline url prefix.

Breaking Changes

• Entity Type-Get API

  • In Response Parameters:

    • Changed the datatype of inlineFile.inlineFileUrlPrefix from String to List<String>.

---

SDK Release 1.15.0

Added support for Rank synchronization

Backward Compatible Changes

• Entity Type-Get API

  • In Response Structure:

    • Field rank is added.

---

SDK Release 1.14.0

Added support for attachment file comment

Backward Compatible Changes

• Attachment Create API and Attachment Update API

  • In request body fileComment field, an optional attachment file comment is added.

  • For example, if the attachment "Image.jpg" needs to add with the file comment "Sample trace image," we can use this file comment.

---

SDK Release 1.13.0

Added support for forming Remote Link using different base URL

Breaking Changes

• Entity Type-Get API

  • In Response Structure:

    • In entityWebUrl field, a new field baseUrl is added and urlTemplate attribute is renamed to trailingTemplate.

    • These changes will be used to form a link.

      • Example: if the original urlTemplate is https://example.com/{0}/{1}/{2}, it will now be split into:

        • baseUrl: https://example.com/

        • trailingTemplate: {0}/{1}/{2}.

---

SDK Release 1.12.0

Added support for fetch mapped data only feature

Backward Compatible Changes

• Entity–Get

  • In URI Parameters:

    • A new query parameter, fieldList, has been added.

    • This parameter will have list of fields, and only the fields present in the fieldList need to be fetched.

    • If an empty list is provided, all field values need to be returned.

    • Note: No in-memory filtration is required if the endpoint API does not support field filtering. In that case, the connector can return all fields.

---

SDK Release 1.11.0

Added support for entity type and project movement

Breaking Changes

• Entity–Get

  • In URI Parameters:

    • The entityTypeId is changed from path parameter to query parameter.

    • This will be used in return field values for a given entity id without filter on entityTypeId or projectId in case it is sent as null.

Backward Compatible Changes

• Entity Types-List API

  • In Response Payload:

    • New metadata for belongsToCategories and projectMovementSupported is introduced.

    • These metadata will be used in entity type and project movement.

      • belongsToCategories will help to determine in which category given entity Type belongs.

      • crossProjectMovementSupport will help to determine if project movement is supported through API for the given entity Type or not.

Added support for filtering comments after specified time

Backward Compatible Changes

• Get_Comments

  • In URI Parameters:

    • New parameter afterTime is introduced, which can be used when end system supports time based filtering on comments.

Added archive support for entity

Breaking Changes

• Entity – Delete API

  • In URI Parameters, added param deletionType.

Backward Compatible Changes

• Entity Types – List API

  • In Response Payload, added field isArchiveSupported.

• Entity Type – Get API

  • In Response Payload, added field archiveMetadata.

---

SDK Release 1.10.0

Optimized Entity-List API

Backward Compatible Changes

• Entity-List API

  • In Response Payload:

    • Fields provided in fieldNameInfo in response payload for Entity Type-Get API and any field which can be configured for end system storage should be part of response payload.

---

SDK Release 1.9.0

Added support for UserMention and EntityMention for MarkDown datatype and introduced support for subStepNumber in updateEntity

Breaking Changes

• Entity-Update API

  • In URI Parameters:

    • New parameter is introduced for subStepNumber.

    • Only consider the subStepNumber change in the updateEntity if the multiStepUpdate field provided in the multiStepUpdate is either STATIC_SUB_STEPS or DYNAMIC_SUB_STEPS.

    • This parameter allows users to detect which API call to make based on Step number in which the field/fields came. Useful when there is separate API to transition Status from one state to another and all other fields can be updated in single update request to end system.

Backward Compatible Changes

• Connector_Metadata–Get

  • In Response Payload:

    • New metadata for additionalMetadata is introduced.

    • This will be used to know if the connector supports user search based on userName and user search on email.

---

SDK Release 1.8.0

Added support for Dynamic Retrieval of lookup fields in integration advance setting screens.

Breaking Changes

• History-List API, Attachment_History-List, Comment_History-List, Link_History-List

  • In corresponding URI Parameters:

    • New parameter orderByDirection is introduced.

    • This parameter gives direction for sorting to all the fields listed in history metadata sortableFields set.

• Lookup_Field_Values-Get

  • In URI Parameters:

    • New parameter fieldScope is introduced.

    • This parameter gives the Scope where Lookup values for a field are to be displayed.

---

SDK Release 1.7.0

Added support for searching mention in HTML data type using regex

Backward Compatible Changes

• Entity Type-Get API

  • In Response Parameters:

    • New parameter introduced for fieldDataType field of userMention and entityMention.

    • This parameter will allow user to detect mention from html data type using regex. This is useful when it's not possible to detect all the mention using html selector.

---

SDK Release 1.6.0

Added Support for Reference Fields

Backward Compatible Changes

• Entity Type-Get API

  • In Response Structure:

    • In fields, referenceFieldMetadata field is added.

    • In fieldNameInfo, entityNameFieldName field is added.

• Spring Boot version is upgraded from 2.7.8 to 3.2.3.