Uploaded image for project: 'Jira Software Data Center'
  1. Jira Software Data Center
  2. JSWSERVER-9928

Sprint field value in issue REST API could be improved

XMLWordPrintable

    • We collect Jira feedback from various sources, and we evaluate what we've collected when planning our product roadmap. To understand how this piece of feedback will be reviewed, see our Implementation of New Features Policy.

      When trying to get the details of an issue through the REST API the response for the Sprint looks something like this:

      customfield_10007:[
"com.atlassian.greenhopper.service.sprint.Sprint@a29f07[rapidViewId=<null>,state=CLOSED,name=NORD - Sprint 42,startDate=2013-07-29T06:47:00.000+02:00,endDate=2013-08-11T20:47:00.000+02:00,completeDate=2013-08-14T15:31:33.157+02:00,id=107]",
"com.atlassian.greenhopper.service.sprint.Sprint@769133[rapidViewId=<null>,state=ACTIVE,name=NORD - Sprint 43,startDate=2013-08-14T15:32:47.322+02:00,endDate=2013-08-23T15:32:47.322+02:00,completeDate=<null>,id=117]"
],

      It looks like toString of the Sprint class which isn't very easy to parse/read with an application. Is their a way to simple get the Sprint Name or id returned through the REST API. It's necessary to be able to retrieve the Sprint value in an internal tool for our QA Team (Spira Test).

      On the other side, using toString in the REST API output doesn't seem like a good idea to me ...

            [JSWSERVER-9928] Sprint field value in issue REST API could be improved

            Katherine Yabut made changes -
            Workflow Original: JAC Suggestion Workflow [ 3069614 ] New: JAC Suggestion Workflow 3 [ 3662616 ]
            Status Original: RESOLVED [ 5 ] New: Closed [ 6 ]
            Owen made changes -
            Workflow Original: Confluence Workflow - Public Facing v4 [ 2625459 ] New: JAC Suggestion Workflow [ 3069614 ]
            Rachel Lin (Inactive) made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 - TEMP [ 2317806 ] New: Confluence Workflow - Public Facing v4 [ 2625459 ]
            Status Original: Closed [ 6 ] New: Resolved [ 5 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 [ 2038712 ] New: JIRA PM Feature Request Workflow v2 - TEMP [ 2317806 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 - TEMP [ 2027144 ] New: JIRA PM Feature Request Workflow v2 [ 2038712 ]
            Katherine Yabut made changes -
            Workflow Original: JIRA PM Feature Request Workflow v2 [ 736134 ] New: JIRA PM Feature Request Workflow v2 - TEMP [ 2027144 ]

            Robin Krom added a comment -

            I wanted to create a new issue, but get an error that I don't have assign permissions...?
            Also I don't know who to inform of this...

             

            Anyway, for people seeing the same issue:

            The described Agile REST API doesn't solve the problem, there is no sprint information in the fields, and the "versionedRepresentations" workaround is a real hack.

            Robin Krom added a comment - I wanted to create a new issue, but get an error that I don't have assign permissions...? Also I don't know who to inform of this...   Anyway, for people seeing the same issue: The described Agile REST API doesn't solve the problem, there is no sprint information in the fields, and the " versionedRepresentations" workaround is a real hack.
            Martin (Inactive) made changes -
            Fix Version/s New: 6.7.7 [ 54998 ]
            Marek Pazik (Inactive) made changes -
            Resolution New: Fixed [ 1 ]
            Status Original: Open [ 1 ] New: Closed [ 6 ]

            Marek Pazik (Inactive) added a comment -

            To string sprint representation leaks by accident to the JIRA issue resource. Since many plugins already parse it we can not change it because that would broke those plugins. So unfortunately it has to remains in current shape
            But since JIRA Agile 6.7.7 Agile REST API contains resource for issues enchanted with agile fields. It is documented as https://docs.atlassian.com/greenhopper/REST/cloud/#agile/1.0/issue-getIssue. Issues from that resource contain proper sprint object.

            Regards
            Marek

            Marek Pazik (Inactive) added a comment - To string sprint representation leaks by accident to the JIRA issue resource. Since many plugins already parse it we can not change it because that would broke those plugins. So unfortunately it has to remains in current shape But since JIRA Agile 6.7.7 Agile REST API contains resource for issues enchanted with agile fields. It is documented as https://docs.atlassian.com/greenhopper/REST/cloud/#agile/1.0/issue-getIssue . Issues from that resource contain proper sprint object. Regards Marek

              Unassigned Unassigned
              c853d67793c8 Maarten Cautreels
              Votes:
              2 Vote for this issue
              Watchers:
              10 Start watching this issue

                Created:
                Updated:
                Resolved: