Understanding the mapping of 'typeId' and 'dependencyType" values between Jira Align UI and API for Dependencies

Summary

Users may experience confusion when attempting to match 'Type' values displayed in the Jira Align UI with the typeId and dependencyType values returned by the API endpoint /rest/align/api/2/Dependencies. This discrepancy arises because the UI presents user-friendly labels, whereas the API provides numerical IDs, leading to difficulties in correlating these values.

Environment

Jira Align

Solution

In Jira Align, the 'Type' values displayed in the UI differ from the numerical IDs returned by the API. This can cause confusion when correlating these values, as the API provides typeId and dependencyType attributes instead of the user-friendly names seen in the UI or export files.

The typeId attribute from the API corresponds to the "Type of Dependency" displayed in Jira Align, indicating the nature of the dependency. The dependencyType attribute refers to the type of work item associated with the dependency.

Mapping typeId to 'Type of Dependency' (Jira Align UI)

Mapping dependencyType to 'Related Work Item'

For example, if an API response returns typeId = 1 and dependencyType = 1, it means the Dependency is a Team Dependency associated with a Feature. Understanding these mappings helps users interpret API data and align it with Jira Align's UI representations.