Uploaded image for project: 'Jira Cloud'
  1. Jira Cloud
  2. JSWCLOUD-20535

Add the ability to define board configuration through the REST API

    • 955
    • 35
    • 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.

      Product Update

      Hi everyone,
      I'm Yousef Abusamak, a Product Manager on the Jira team. I appreciate the ongoing interest and engagement in this request. We recognize that this API is frequently requested, with considerable votes and watchers highlighting its importance.
      We will be moving this issue to be under consideration. While we haven’t committed to delivering this yet, we’re actively evaluating how it fits into our roadmap. Your feedback is invaluable in shaping our priorities, and we’ll continue to assess how we can best address this need.
      I’ll share any updates as soon as we have more to communicate. Thanks for your patience and for being part of our community!
      Best,
      Yousef

      Problem Description

      At the moment, we have endpoints to view board settings. ie 

      However, there is no public endpoint in Cloud to allow for board configuration mutation. Ie, update the Board Administrator field via rest API, configure swimlanes or specify the columns of a board

      Solution

      Allow for the possibility, ie via API endpoint, to perform board configuration updates. 

      Workaround

      No workaround available

      Original Description

      The Jira Software REST API doesn't allow the columns of a board to be specified or configuring swimlanes when creating a board. It also doesn't allow the columns of an existing board to be updated/modified. It is suggested that the API be expanded to include these features.

       

            [JSWCLOUD-20535] Add the ability to define board configuration through the REST API

            Pinned comments

            Pinned by Yousef Abusamak

            Yousef Abusamak added a comment -

            Hi everyone,
            I'm Yousef Abusamak, a Product Manager on the Jira team. I appreciate the ongoing interest and engagement in this request. We recognize that this API is frequently requested, with considerable votes and watchers highlighting its importance.
            We will be moving this issue to be under consideration. While we haven’t committed to delivering this yet, we’re actively evaluating how it fits into our roadmap. Your feedback is invaluable in shaping our priorities, and we’ll continue to assess how we can best address this need.
            I’ll share any updates as soon as we have more to communicate. Thanks for your patience and for being part of our community!
            Best,
            Yousef

            Yousef Abusamak added a comment - Hi everyone, I'm Yousef Abusamak, a Product Manager on the Jira team. I appreciate the ongoing interest and engagement in this request. We recognize that this API is frequently requested, with considerable votes and watchers highlighting its importance. We will be moving this issue to be under consideration. While we haven’t committed to delivering this yet, we’re actively evaluating how it fits into our roadmap. Your feedback is invaluable in shaping our priorities, and we’ll continue to assess how we can best address this need. I’ll share any updates as soon as we have more to communicate. Thanks for your patience and for being part of our community! Best, Yousef

            All comments

            Pinned by Yousef Abusamak

            Yousef Abusamak added a comment -

            Hi everyone,
            I'm Yousef Abusamak, a Product Manager on the Jira team. I appreciate the ongoing interest and engagement in this request. We recognize that this API is frequently requested, with considerable votes and watchers highlighting its importance.
            We will be moving this issue to be under consideration. While we haven’t committed to delivering this yet, we’re actively evaluating how it fits into our roadmap. Your feedback is invaluable in shaping our priorities, and we’ll continue to assess how we can best address this need.
            I’ll share any updates as soon as we have more to communicate. Thanks for your patience and for being part of our community!
            Best,
            Yousef

            Yousef Abusamak added a comment - Hi everyone, I'm Yousef Abusamak, a Product Manager on the Jira team. I appreciate the ongoing interest and engagement in this request. We recognize that this API is frequently requested, with considerable votes and watchers highlighting its importance. We will be moving this issue to be under consideration. While we haven’t committed to delivering this yet, we’re actively evaluating how it fits into our roadmap. Your feedback is invaluable in shaping our priorities, and we’ll continue to assess how we can best address this need. I’ll share any updates as soon as we have more to communicate. Thanks for your patience and for being part of our community! Best, Yousef

            Kaloyan Gadzhev added a comment -

            Please add endpoints for updating border configuration

            Kaloyan Gadzhev added a comment - Please add endpoints for updating border configuration

            As many have previously noted, this is a significant step to achieve full automation of projects, yet a vital miss. The configuration of boards is a tedious task, yet driving standardisation for users across the UX is fundamental to behaviours of the users.

            Michael Moss added a comment - As many have previously noted, this is a significant step to achieve full automation of projects, yet a vital miss. The configuration of boards is a tedious task, yet driving standardisation for users across the UX is fundamental to behaviours of the users.

            Hello,

            I absolutely top up this comment:

            "If you already have API to get the columns, why do you need to gather interest for setting them.
            They should come as a set, not one by one and should be already planned for implementation.
            Everyone who wants to create projects with custom workflows with REST will struggle at this last configuration step."

            This is the last missing puzzle to automate creating projects fully, yet one of the most crucial.

            Daniel Bagiński added a comment - Hello, I absolutely top up this comment: "If you already have API to get the columns, why do you need to gather interest for setting them. They should come as a set, not one by one and should be already planned for implementation. Everyone who wants to create projects with custom workflows with REST will struggle at this last configuration step." This is the last missing puzzle to automate creating projects fully, yet one of the most crucial.

            Hello team, 
            Is there any update concerning the PUT request to edit a board config ?

            bilel.arfaoui added a comment - Hello team,  Is there any update concerning the PUT request to edit a board config ?

            rchiquete We desperately need this to be added!!! It is mind boggling that you can GET the board configurations, but cannot PUT (or POST) them... Please Atlassian, consider integrating this feature as it would be a total game-changer for us, and would allow us to skip a ton of manual work that we have to do when creating new boards that are heavily customized.

            Zachary Howard added a comment - rchiquete We desperately need this to be added!!! It is mind boggling that you can GET the board configurations, but cannot PUT (or POST) them... Please Atlassian, consider integrating this feature as it would be a total game-changer for us, and would allow us to skip a ton of manual work that we have to do when creating new boards that are heavily customized.

            KLIPPERT, ROSS added a comment - - edited

            This is a definite need for our enterprise support.  The following specific endpoints would be valuable:

            Initial "Must haves"

            • Ability to Copy an existing board
            • Assign/Update Board Administrators
            • Assign/Update Board Location
            • Assign/Update Board Filter

            Additional "Nice to haves"

            • Define/Modify columns
            • Assign/Modify status to column mapping
            • Define/Modify Quick Filters
            • Define/Modify Swim Lanes
            • Define Swim Lane Queries
            • Define/Modify Card Colors
            • Define/Modify Card Layout

            KLIPPERT, ROSS added a comment - - edited This is a definite need for our enterprise support.  The following specific endpoints would be valuable: Initial "Must haves" Ability to Copy an existing board Assign/Update Board Administrators Assign/Update Board Location Assign/Update Board Filter Additional "Nice to haves" Define/Modify columns Assign/Modify status to column mapping Define/Modify Quick Filters Define/Modify Swim Lanes Define Swim Lane Queries Define/Modify Card Colors Define/Modify Card Layout

            With Project Templates (JRACLOUD-7020 Allow support for project schemes or templates - Create and track feature requests for Atlassian products.) nowhere in sight, this request would go a long way in at least letting us build something our damn selves.

            Rune Rasmussen added a comment - With Project Templates ( JRACLOUD-7020 Allow support for project schemes or templates - Create and track feature requests for Atlassian products.) nowhere in sight, this request would go a long way in at least letting us build something our damn selves.

            Dominik added a comment -

            +1 - Automation is only half done without this feature.

            Dominik added a comment - +1 - Automation is only half done without this feature.

            Mark J Cunningham added a comment - - edited

            This would be great, as it is currently odd that you can create a project via automation that triggers the relevant APIs to

            Validate the Project Name and Key and return new value if already used

            use value to create a project from in built or own templates

            ie

            Using in built templates

             

            {
              "name": "{{Issue.Project Name}}",
              "key": "{{Issue.Project Key}}",
              "assigneeType": "UNASSIGNED",
              "description": "{{Issue.Project Name}}",
              "leadAccountId": "{{Issue.Project Lead.accountId}}",
              "projectTypeKey": "software",
              "notificationScheme": {{notificationID}},
              "permissionScheme": {{permissionID}},
              "issueSecurityScheme": {{issueSecurityID}},
              "projectTemplateKey": "{{projectTemplateKey}}"
            }
            

             

            or own templates

             

            {
              "name": "{{Issue.Project Name}}",
              "key": "{{Issue.Project Key}}",
              "assigneeType": "UNASSIGNED",
              "description": "{{Issue.Project Name}}",
              "leadAccountId": "{{Issue.Project Lead.accountId}}",
              "projectTypeKey": "software",
              "notificationScheme": {{notificationID}},
              "permissionScheme": {{permissionID}},
              "issueSecurityScheme": {{issueSecurityID}},
              "categoryId": {{categoryID}},
              "issueTypeScheme": {{issueTypeID}},
              "fieldConfigurationScheme": {{fieldConfigurationID}},
              "workflowScheme": {{workflowID}}
            }
            

             

            Then for own templates Create the filter for the project and create Scrum or Kanban board

             

            Add People and/or groups to the relevant roles in the project

             

            But you cannot set the Board configuration for the project.

            You can only GET not PUT or POST

            https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-boardid-configuration-get

            GET/rest/agile/1.0/board/{boardId}/configuration

            Mark J Cunningham added a comment - - edited This would be great, as it is currently odd that you can create a project via automation that triggers the relevant APIs to Validate the Project Name and Key and return new value if already used use value to create a project from in built or own templates ie Using in built templates   { "name" : "{{Issue.Project Name}}" , "key" : "{{Issue.Project Key}}" ,   "assigneeType" : "UNASSIGNED" , "description" : "{{Issue.Project Name}}" , "leadAccountId" : "{{Issue.Project Lead.accountId}}" ,   "projectTypeKey" : "software" , "notificationScheme" : {{notificationID}}, "permissionScheme" : {{permissionID}}, "issueSecurityScheme" : {{issueSecurityID}}, "projectTemplateKey" : "{{projectTemplateKey}}" }   or own templates   { "name" : "{{Issue.Project Name}}" , "key" : "{{Issue.Project Key}}" ,   "assigneeType" : "UNASSIGNED" , "description" : "{{Issue.Project Name}}" , "leadAccountId" : "{{Issue.Project Lead.accountId}}" ,   "projectTypeKey" : "software" , "notificationScheme" : {{notificationID}}, "permissionScheme" : {{permissionID}}, "issueSecurityScheme" : {{issueSecurityID}}, "categoryId" : {{categoryID}}, "issueTypeScheme" : {{issueTypeID}}, "fieldConfigurationScheme" : {{fieldConfigurationID}}, "workflowScheme" : {{workflowID}} }   Then for own templates Create the filter for the project and create Scrum or Kanban board   Add People and/or groups to the relevant roles in the project   But you cannot set the Board configuration for the project. You can only GET not PUT or POST https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-boardid-configuration-get GET/rest/agile/1.0/board/{boardId}/configuration

              Unassigned Unassigned
              dmorrow@atlassian.com Dugald Morrow
              Votes:
              314 Vote for this issue
              Watchers:
              153 Start watching this issue

                Created:
                Updated: