Uploaded image for project: 'Jira Align'
  1. Jira Align
  2. JIRAALIGN-8214

Ensure consistent property representation in Jira Align REST API Objectives endpoint

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Unresolved
    • REST API
    • None
    • 1
    • Our product teams collect and evaluate feedback from a number of different sources. To learn more about how we use customer feedback in the planning process, check out our new feature policy.

      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.

              fea1a6ef3355 Yannick Genin
              238f0a5fa446 Rodrigo San Vicente
              Votes:
              1 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: