Uploaded image for project: 'Jira Platform Cloud'
  1. Jira Platform Cloud
  2. JRACLOUD-84212

REST API Update screen does not allow updating Description by keeping same screen name

XMLWordPrintable

      Issue Summary

      REST API Update screen /rest/api/3/screens/{screenId} endpoint does not allow to only edit the description of the screen while keeping the screen name same.

      Steps to Reproduce

      • Try to then update the description using REST API Update screen /rest/api/3/screens/{screenId} like this
        1. if we don’t include the name
          curl --location --request PUT 'https://$sitename.atlassian.net/rest/api/3/screens/$screenId' \
          --header 'Accept: application/json' \
          --header 'Content-Type: application/json' \
          --data '{
              "description": "Testing"
          }'
          
          ## this'll give the following error
          {
              "errorMessages": [
                  "The screen name has to be provided."
              ],
              "errors": {}
          }
          
        2. if we include the same name
          curl --location --request PUT 'https://$sitename.atlassian.net/rest/api/3/screens/$screenId' \
          --header 'Accept: application/json' \
          --header 'Content-Type: application/json' \
          --data '{
              "name": "screen name",
              "description": "Testing"
          }'
          
          ## this'll give the following error, although it's the same screen that we're trying to update.
          {
              "errorMessages": [
                  "The name is used by another screen."
              ],
              "errors": {}
          }
          
        3. To make the call successful, we’ll need to change the name to something unique.

      Expected Results

      REST API to allow to only update the Description in the screen

      Actual Results

      REST API does not allow updating only the Description

      Workaround

      Currently there is no known workaround for this behavior. A workaround will be added here when available

              pvanecek Pavel V
              2a7f4ad44e0d Ramchandra Kudtarkar
              Votes:
              2 Vote for this issue
              Watchers:
              7 Start watching this issue

                Created:
                Updated:
                Resolved: