Atlassian Epic and Parent Fields Jira REST API Deprecation
Atlassian have announced that parent and child issue associations are being standardised for company-managed and team-managed projects. As a result, they are deprecating the Epic Link
and Parent Link
custom fields in the REST API and webhooks.
Rewrite scripts with HAPI
We recommend using HAPI to access issues and their fields. HAPI gives you full access to all fields of the Parent
issue, simplifies your code, improves readability, and helps safeguard it against future Atlassian deprecations.
You'll see these fields when working with Jira issues. See the before and after deprecation examples below:
groovydef issueKey = 'TEST-1' def issue = get("/rest/api/2/issue/${issueKey}") .header('Content-Type', 'application/json') .asObject(Map) //get Epic Link def epic = issue.fields.customfield_10014 epic
groovydef issueKey = 'TEST-1' def issue = Issues.getByKey(issueKey) issue.getParentObject().getKey()
Similarly, with the Parent
link, you can use HAPI to replace its usages and get access to the issue fields of the parent object.
Atlassian has published a detailed guide that provides examples, various API responses, and information on how they’re changing. For cases where rewriting the code to use HAPI isn’t straightforward, please refer to the guidance in Atlassian's documentation.
Endpoints with fields deprecated
Issue Retrieval APIs
Endpoints affected | Recommended alternative field | Type |
---|---|---|
| Parent | Company-managed projects |
Issue Creation & Update APIs
Endpoints affected | Recommended alternative field | Type |
---|---|---|
| Parent | Company-managed projects and team-managed projects |
Issue Type Metadata APIs
Endpoints affected | Recommended alternative field |
---|---|
| hierarchyLevel |
Webhooks Affected
All webhook events where the payload includes issues with their fields for company-managed projects:
issuelink_created *
issuelink_deleted *
jira:issue_created
jira:issue_updated
* Where style is: jira_gh_epic_story
or jira_subtask.
Issue Data
Webhook payloads affected | Recommended alternative field | Type |
---|---|---|
All webhook events returning issue fields (e.g.,
| Parent | Company-managed projects |
Issue Links
Events affected | Recommended alternative field | Type |
---|---|---|
|
| Company-managed projects and team-managed projects |
Changelog
Events affected | Recommended alternative field | Type |
---|---|---|
Any webhook with changelog (e.g.,
| IssueParentAssociation | Company-managed projects and team-managed projects |