untranslatedName property returned within the issue types API response

Hi,

Today we have found a bug in our extension that is being caused by the issue types REST endpoint sending down translated issue types when the users account is set to a language other than english

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types/#api-rest-api-3-issuetype-get

The documentation doesn’t appear to mention the untranslatedName property.

We were wondering the following

  • How long has this property been in existence for?
  • What other REST endpoints will return this property?
  • Are there any changes planned in the future regarding multiple languages being integrated within the REST endpoints?

Thanks!

2 Likes

Hi @BenDavies. Just did a cursory investigation, the property untranslatedName was introduced to both the issuetype and createmeta endpoints some time in late June 2020.

From what I understand so far, this change only added a new property (untranslatedName). Let me know if that’s incorrect.

  • Are there any changes planned in the future regarding multiple languages being integrated within the REST endpoints?

We’ll reach out internally to find an answer to this question.


Just for reference, I’m including the payload below for a call to /rest/api/3/issuetype as a user with Spanish set as language in user profile:

  {
    "self": "https://devinstance001.atlassian.net/rest/api/3/issuetype/10001",
    "id": "10001",
    "description": "Una función o funcionalidad expresada como objetivo del usuario.",
    ...
    "name": "Historia",
    "untranslatedName": "Story",
    "subtask": false
  }
1 Like

Hi @nmansilla. Do you have any update on this? Is it safe to use untranslatedName property or is it some experimental feature which may be removed in the future? It’s still not documented
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types/#api-group-issue-types
Thank you!

Hi @DaniilKovalev ,

I just reached out to the developer who introduced the field. The field is intended to be publicly available, but it’s documentation is currently hidden. The developer said he would ensure the field becomes documented within the next week.

Regards,
Dugald

1 Like

Hi @dmorrow ,
That’s great! Thanks a lot for your help!

1 Like

Hi @dmorrow @nmansilla

Do you have a link to the documentation on the untranslatedName property?

Also, will the untranslatedName property be set in the language on the users jira instance or will it always be the same language across all instances?

Thanks,
Ben