Lack of serialization handler for custom field "Jira Software sprint field"

XMLWordPrintable

    • Type: Suggestion
    • Resolution: Unresolved
    • None
    • Component/s: REST API
    • None

      Environment/Version

      All

      Issue Summary

      Custom field that represents sprint has no serialization handler, as a result in REST API and in webhook payloads it is serialized using default serialization, which is rather useless for consumers:

          "customfield_10001": [
            "com.atlassian.greenhopper.service.sprint.Sprint@32ef49d8[activatedDate=2025-11-13T08:27:31.136Z,autoStartStop=false,completeDate=<null>,endDate=2025-11-27T08:27:00.000Z,goal=,id=3,incompleteIssuesDestinationId=<null>,name=SCRUM Sprint 1,rapidViewId=2,sequence=3,startDate=2025-11-13T08:27:00.000Z,state=ACTIVE,synced=false]"
          ], 

      Steps to Reproduce

      1. make API call to fetch issue that is in scope of sprint:
      curl -H "Authorization: Bearer ${TOKEN}" -H "Accept: application/json" https://<base-address>/rest/api/2/issue/<issue-key>

      Expected Results

      I would imagine that it should be serialized in a similar manner like:

      "customfield_10002": "TQ-1", 

      For example:

      "customfield_10001": [
      "SCRUM Sprint 1"
      ] 

      Actual Results

          "customfield_10001": [       "com.atlassian.greenhopper.service.sprint.Sprint@32ef49d8[activatedDate=2025-11-13T08:27:31.136Z,autoStartStop=false,completeDate=<null>,endDate=2025-11-27T08:27:00.000Z,goal=,id=3,incompleteIssuesDestinationId=<null>,name=SCRUM Sprint 1,rapidViewId=2,sequence=3,startDate=2025-11-13T08:27:00.000Z,state=ACTIVE,synced=false]"     ],  

            Assignee:
            Unassigned
            Reporter:
            Maciej Szarecki
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: