API 2.0 Breaking Changes Coming to 10.92

[#1]

As we continue our journey to improve the usability and performance of our API, we want to keep you informed about some changes coming to the API 2.0 in version 10.92 and beyond so you can plan accordingly.

These updates will bring consistency to our API experience, improve processing speed, and enable new features down the road. Your API calls will have to be modified to accommodate these changes.

If you have any questions on these changes, reach out to your Technical Account Manager, or just comment on this post!

Change 1: Capabilities API - Property Re-name and Deprecation

We are making these changes to improve usability and consistency for Capabilities API.

Property re-name:

• complexity renamed to kanoComplexity

• certainty renamed to kanoCertainty

• programId renamed to primaryProgramId

Property deprecation

• lastModifiedDate will be deprecated. Please use the existing lastUpdatedDate property instead.

We will also add a new additionalProgramIDs property.

These changes will be included in 10.92 (with updated Swagger docs), deployed to test environments on April 10, 2021, and to production instances on April 24, 2021, per our release calendar.

Important note:

We plan to make similar changes to other API objects in the future to address usability gaps.

When we are ready for the next batch of updates we’ll share another post like this.

Change 2: Enforced API Token Formats

These changes will improve your API performance and enable better logging features in the future.

Current supported token formats:

• tokenkeynumber123

• user:Id|tokenkeynumber123

Future supported token formats

• user:Id|tokenkeynumber123

In the future, we will only support the format for API Tokens that includes your user:Id. The exact enforcement date for this change is TBD, but we strongly encourage that you update your API calls with this new format now. One immediate benefit you get is better performance because this token format helps our API process authentication much faster.

You can grab this token in Jira Align on the user profile (top left) > Edit Profile > Account Details > API Token > API 2.0 Token.

Important note:

API 2.0 will only support the API 2.0 tokens displayed in the UI.

Thanks for your help!