-
Suggestion
-
Resolution: Unresolved
-
None
-
1
-
User Problem
When using the Jira Align REST API, specifically the Objectives endpoint, users encounter an issue where the "epicIds" property is entirely absent from the response body if no Epics are associated with the Objective. This inconsistency causes problems, especially when performing a GET call with "epicIds" as one of the Select parameters, resulting in a 500 internal server error.
In contrast, other properties like "featureIds" or "impedimentIds" are included in the response as empty arrays when they have no associated data, which is the expected behavior.
Suggested Solutions
- Consistent Property Representation: Modify the Objectives endpoint to always include the "epicIds" property in the response body, even when no Epics are associated with the objective. Represent it as an empty array to maintain consistency with other properties like "featureIds" and "impedimentIds."
Current Workarounds
- Manual Check and Handling: Users need to implement additional logic to manually check for the presence of the "epicIds" property in the response and handle cases where it is missing. This involves extra coding effort to ensure their application does not break when the property is absent.
By addressing this Suggestion, the API will provide a consistent user experience, reducing the need for complex workarounds and lowering the risk of errors in applications using the API.
- is resolved by
-
JIRAALIGN-8225 Performing a GET Request on Objectives endpoint with 'epicIds' parameter results in Internal Error 500 when no epics are associated
-
- Closed
-
- relates to
-
ALIGNSP-28904 Loading...