Last updatedOct 23, 2019

Deprecation notice - representation of Request Language in Get Issue response

From 18th August 2019, Jira REST API responses that include the Request Language custom field type will no longer return a single translated string representing the body of the field. This data will still be available as part of a new JSON object representation wherever a string was previously expected.

Replacement

After this date, you will only be able to get data for the Request Language custom field through its new JSON representation. The new JSON representation includes both the old value and a language key that is not dependant on the current user's language settings. The new shape is available today via the get issue method with expanded versionedRepresentations in the  Jira Platform REST API.

Why?

A single string which is translated to the current user's language is not as useful as an object which also contains a standard language code that is the same regardless of the current user's language settings.

Feature parity

The new JSON object contains the old translated string, so this change has feature parity.

Example

Format to be deprecated:

Get Issue call:

1
https://your-domain.atlassian.net/rest/api/2/issue/DEMO-1?fields=customfield_11459

GET Issue response:

For a user who has their language set to "français (France)"

1
"customfield_11459": "anglais"

For a user who has their language set to "English (US)"

1
"customfield_11459": "English"

New version:

Get Issue call:

1
https://your-domain.atlassian.net/rest/api/2/issue/DEMO-1?fields=customfield_11459

GET Issue response:

For a user who has their language set to "français (France)"

1
2
3
4
"customfield_11459": {
    languageCode: "en",
    displayName: "anglais"
}

For a user who has their language set to "English (US)"

1
2
3
4
"customfield_11459": {
    languageCode: "en",
    displayName: "English"
}

Both versions:

As of today, the field data may be fetched in both old and new formats by using the versionedRepresentations expand.

Get Issue call:

1
https://your-domain.atlassian.net/rest/api/2/issue/DEMO-1?fields=customfield_11459&expand=versionedRepresentations

GET Issue response:

1
2
3
4
5
6
7
"customfield_11459": {
    "1": "English"
    "2": {
        languageCode: "en",
        displayName: "English"
    }
}