Deprecation of fields values Epic Link and Parent in issue history changelogs

[RhysDiab]

Thanks @Hayden

That answers my question.

Looking forward to the new JQL clause for querying children and parents.

One thing I noticed yesterday is that 'IssueParentAssociation' is now being returned when you change the parent of a next-gen issue.

However, the fromString and toString do not contain the issue keys as per your example payload. They appear to have the same value as from and to.

Here is an example of what is returned when the webhook is called:

fieldsChanged: [
    {
      field: 'IssueParentAssociation',
      fieldtype: 'jira',
      from: '11198',
      fromString: '11198',
      to: '11206',
      toString: '11206'
    }
  ]

The issue id is still useful and it’s a great improvement for this event to now fire, but just letting you know the payload format is a little different to what is expected.

Cheers,

Rhys

[Hayden]

Hi @RhysDiab

This is currently expected behaviour for Team Managed Projects (TMP) - you will be able to see this in the change logs on issues when you reparent them as well.

We do have an improvement action coming in future to return issue keys in the same way as we do for Company Managed Projects. There will be another community post which will announce this improvement, but its not currently high priority so I cannot provide a timeline just yet.

Thanks,
Hayden

[KentPitman]

Thanks for the info here, especially since I gather from this page that functionality like Epic Link will go away soon and that was a surprise. For example, on your page Search for Advanced Roadmaps custom fields in JQL | Jira Software Cloud | Atlassian Support it implies that the deprecation period will soon begin, not end.

There is an info note on that page that says " The Epic Link and Parent values returned in field in issue history changelogs will be deprecated on 10 December 2021 ." but unless I misunderstand you here, I think it means to say " The Epic Link and Parent values returned in field in issue history changelogs are presently deprecated and will no longer be supported as of 10 December 2021 ." Anyone who has been relying on this statement is in for a rude awakening.

It might not be a bad idea to remind your doc people that this terminology is super-important to get right and that all kinds of problems are likely to blindside your customers if they get it wrong. Because of the wording on that page, I certainly inferred I could be lazy about clicking through to this link and begin worrying on that time and that a comfortable period of transition after that time would be allowed. It was quite surprising to click through and find that this was not so.

Many software developers use this term (Deprecation - Wikipedia) improperly and a lot of confusion results, so please be careful. Thanks.

[Hayden]

Hi @KentPitman!

Thank you for bringing this to my attention - I was not aware that this note existed on that page. I agree with you completely that this note does not communicate clearly the intention we have around when Epic Link and Parent values will no longer be supported.

I will work to get this updated in order to avoid confusion for folks who come across it in future.

Thanks again!

[KyledOliveira]

Hi @Hayden

I notice, as expected, that I can request /rest/api/v2/issue/<id> with expand=changelog and I will get the expect differences the changelog such as:

 [
  {"field"=>"Epic Link",
   "fieldtype"=>"custom",
   "fieldId"=>"customfield_10008",
   "from"=>"55475",
   "fromString"=>"KT-5",
   "to"=>"55477",
   "toString"=>"KT-7"}
 ],
 [
  {"field"=>"IssueParentAssociation",
   "fieldtype"=>"jira",
   "from"=>"55475",
   "fromString"=>"KT-5",
   "to"=>"55477",
   "toString"=>"KT-7"}
  ],

However, when I’m getting the jira:issue_updated webhook (for a company managed project), I only see the Epic Link field and not the IssueParentAssociation field.

I looks like this was an earlier question which referred to the an another deprecation notice that appears to have been cancelled.

I wanted to reach out to confirm if the webhook changes were going through? and if so, how would I get the IssueParentAssociation field to be included in the webook changelog items.

[KonstantinK]

Hi @david2, thanks for your patience with the wider deprecation announcement!

We’ve just published it: Deprecation of the Epic Link, Parent Link and other related fields in REST APIs and webhooks. It has all the details and provides a new 6-months deprecation period. Feel free to ask any questions in the new announcement.

To avoid confusion, the old one https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-hierarchy-levels/ has been canceled and can be safely ignored.

The other two related announcements are still relevant:

• This announcement
• Removing hierarchy level IDs from Jira cloud platform APIs.

Thanks,
Konstantin

[IgorShirinsky]

Hi folks,
Since history item does not provide the fieldId e.g.

{
    "field": "IssueParentAssociation",
    "fieldtype": "jira",
    "from": null,
    "fromString": null,
    "to": "10084",
    "toString": "BT-1"
}

and parent and Epic Link fields are considered as two different ones i.e.

{
    "id": "parent",
    "key": "parent",
    "name": "Parent",
    "custom": false,
    "orderable": false,
    "navigable": true,
    "searchable": false,
    "clauseNames": [
        "parent"
    ]
}
{
    "id": "customfield_10014",
    "key": "customfield_10014",
    "name": "Epic Link",
    "untranslatedName": "Epic Link",
    "custom": true,
    "orderable": true,
    "navigable": true,
    "searchable": true,
    "clauseNames": [
        "cf[10014]",
        "Epic Link"
    ],
    "schema": {
        "type": "any",
        "custom": "com.pyxis.greenhopper.jira:gh-epic-link",
        "customId": 10014
    }
}

Is there a way to understand which field the history item belongs to properly?
We are using the changelog items for analytical purposes and the wrong field recognition may cause a data integrity issue.

Thanks in advance!