Breaking changes for Power Custom Fields v.6.3.820.0 and 7.1.1000.0

Open

Release date: Jan 28, 2025

This page includes the breaking changes introduced to Power Custom Fields that can affect your existing system. Review the changes carefully and perform any necessary actions to maintain the app’s functionality.

Jira compatibility:

JSON format requirement for multiple-value fields in REST API

Starting with version 6.3.x/7.1.x, Power Custom Fields requires proper JSON array format for setting multiple values through Jira's REST API, replacing the previous #|# separator convention. This change affects only REST API integrations, while UI-based usage remains unchanged.

Impact

This change affects customers who:

• Use Jira's REST API to set values for PCF fields.

• Work with multiple-value fields (multi-select, checkbox with multiple values).

• Are upgrading to version 6.3.x/7.1.x or later.

Customers who only use fields within the Jira interface will not be affected, as their existing values will be automatically migrated through upgrade tasks.

Benefits

• Standardization of data format using proper JSON syntax

• Improved consistency with modern API practices

• Better maintainability and readability of API requests

Changes introduced

The format for sending multiple values through the REST API has been updated to use standard JSON array notation instead of the custom string separator. This new format applies to all field types that can hold multiple values:

• PCF - Multi Select

• PCF - Multiple Autocomplete

• PCF - Checkbox

Before Version 6.3.x/7.1.x, multiple values were concatenated using a custom #|# separator string:

Starting with version 6.3.x/7.1.x and Later, multiple values are sent as a proper JSON array of objects:

No changes were introduced for single-value fields. The format remains consistent:

Solution

Customers using Jira's REST API to update Power Custom Fields must:

1. Identify if you are using multiple-value fields.

2. Check your current PCF version.

3. If upgrading to version 6.3.x/7.1.x or later:

   • Update all API calls that set multiple values to use the new JSON array format.

   • Test your integrations to ensure they work with the new format.

4. If maintaining an version 6.2.x/7.0.x or earlier:

   • Continue using the existing #|# separator format.

   • Plan for the format change when you eventually upgrade.

Migration

• Existing data will be automatically migrated for users upgrading their PCF version to 6.3.x//7.1.x or higher.

• When using version 6.2.x/7.0.x or earlier, continue using the previous format with the #|# separator.