Last updated Aug 19, 2021

Rate this page:

Deprecation notice - Hierarchy levels will no longer be included on issues

What is changing?

Atlassian is standardizing how issue type hierarchies are created and configured across Jira, Jira Software, Jira Service Management, and Advanced Roadmaps for company-managed and team-managed projects. From 1 November 2021, issue links will not be used to link subtasks to their parents and epics to stories. Instead those relationships can be determined using issue parent associations, a concept introduced for team-managed projects. As a result, Jira APIs will not return issue-parent relationships in issuelink-related operations.

Why is Atlassian making this change?

There are several different hierarchy structures that have to be reconciled when developing tools for the Jira product range. Standardizing on one hierarchy format makes it easier to develop tools and integrate products. This simplification will help us create and roll out new features to customers faster.

What do I need to do?

Plan to migrate away from using issuelinks to fetch issue/parent relationships in your hierarchies. For non-bulk tasks, swap the hierarchy out for the parentId field. A new operation will be provided to fetch issue/parent relationship data for bulk tasks.

Which operations are changing?

Jira Software Cloud REST API

OperationMethodEndpointScopeDeprecation
Get issues for backlogGET/rest/agile/1.0/board/{boardId}/backlogResponseissueLinks of the parent/child type in response body
Get issues without epic for boardGET/rest/agile/1.0/board/{boardId}/epic/none/issueResponseissueLinks of the parent/child type in response body
Get board issues for epicGET/rest/agile/1.0/board/{boardId}/epic/{epicId}/issueResponseissueLinks of the parent/child type in response body
Get issues for boardGET/rest/agile/1.0/board/{boardId}/issueResponseissueLinks of the parent/child type in response body
Get board issues for sprintGET/rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issueResponseissueLinks of the parent/child type in response body
Get issues without epicGET/rest/agile/1.0/epic/none/issueResponseissueLinks of the parent/child type in response body
Get issues for epicGET/rest/agile/1.0/epic/{epicIdOrKey}/issueResponseissueLinks of the parent/child type in response body
Get issueGET/rest/agile/1.0/issue/{issueIdOrKey}ResponseissueLinks of the parent/child type in response body
Get issues for sprintGET/rest/agile/1.0/sprint/{sprintId}/issueResponseissueLinks of the parent/child type in response body

Jira Cloud Platform REST API v3

OperationMethodEndpointScopeDeprecation
Get issueGET/rest/api/3/issue/{issueIdOrKey}Request ResponseissueLinks of the parent/child type in request GET params, issueLinks of the parent/child type in response body
Create issuePOST/rest/api/3/issueRequestissueLinks of the parent/child type in request GET params
Bulk create issuePOST/rest/api/3/issue/bulkRequestissueLinks of the parent/child type in request GET params
Search for issues using JQLGET/rest/api/3/searchRequest ResponseissueLinks of the parent/child type in request GET params
Search for issues using JQLPOST/rest/api/3/searchRequest ResponseissueLinks of the parent/child type in request GET params
Create issue typePOST/rest/api/3/issuetypeRequesttype attribute in request GET params
Get projectGET/rest/api/3/project/{projectIdOrKey}Request ResponseThe expand request parameter will no longer support issueTypeHierarchy and no corresponding data will be included in the response.
Update projectPUT/rest/api/3/project/{projectIdOrKey}Request ResponseThe expand request parameter will no longer support issueTypeHierarchy and no corresponding data will be included in the response.

Jira Cloud Platform REST API v2

OperationMethodEndpointScopeDeprecation
Get issueGET/rest/api/2/issue/{issueIdOrKey}Request ResponseissueLinks of the parent/child type in request GET params, issueLinks of the parent/child type in response body
Create issuePOST/rest/api/2/issueRequestissueLinks of the parent/child type in request GET params
Bulk create issuePOST/rest/api/2/issue/bulkRequestissueLinks of the parent/child type in request GET params
Search for issues using JQLGET/rest/api/2/searchRequest ResponseissueLinks of the parent/child type in request GET params
Search for issues using JQLPOST/rest/api/2/searchRequest ResponseissueLinks of the parent/child type in request GET params
Create issue typePOST/rest/api/2/issuetypeRequesttype attribute in request GET params
Get projectGET/rest/api/2/project/{projectIdOrKey}Request ResponseThe expand request parameter will no longer support issueTypeHierarchy and no corresponding data will be included in the response.
Update projectPUT/rest/api/2/project/{projectIdOrKey}Request ResponseThe expand request parameter will no longer support issueTypeHierarchy and no corresponding data will be included in the response.

Rate this page: