REST api documentation for updating versions needs to be updated

XMLWordPrintable

    • Type: Bug
    • Resolution: Obsolete
    • Priority: Low
    • None
    • Affects Version/s: 7.0.10
    • Component/s: Documentation - All
    • None
    • 7
    • 3
    • Severity 3 - Minor

      Summary

      In REST api documentation for updating issue fields, it appears that the field name to use for updating Fix Versions field is : "Fix Versions". However, it is not right. The correct name to use is "fixVersions".

      Same for "Affects Versions" field, the correct field name is "versions".

      Steps to Reproduce

      Run a REST update request like this :

      curl -D- -u admin:sphere -X PUT --data {\"update\":{\"Fix Version/s\":[{\"add\":{\"name\":\"3\"}}]}} -H "Content-Type: application/json" http://localhost:8709/jira/rest/api/2/issue/TEST-1

      Expected Results

      The request should work fine.

      Actual Results

      Error in Response :

      Field 'Fix Version/s' cannot be set. It is not on the appropriate screen, or unknown.

      Workaround

      Actual request should look like this :
      Fix Versions :

      curl -D- -u admin:sphere -X PUT --data {\"update\":{\"fixVersions\":[{\"add\":{\"name\":\"3\"}}]}} -H "Content-Type: application/json" http://localhost:8709/jira/rest/api/2/issue/TEST-1

      Affect Versions :

      curl -D- -u admin:sphere -X PUT --data {\"update\":{\"versions\":[{\"add\":{\"name\":\"3\"}}]}} -H "Content-Type: application/json" http://localhost:8709/jira/rest/api/2/issue/TEST-1

            Assignee:
            Oksana Levchuk
            Reporter:
            Ruchi Tandon (Inactive)
            Votes:
            3 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: