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

Add, Modify, Delete, and Move quick filters via REST API

XMLWordPrintable

    • 33
    • 1
    • 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.

      Currently there exists the ability to GET quick filters via REST API in Jira Cloud.

      GET /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}

      However this doesn't do me much good – I need the ability to create, modify, and remove them as a result of workflow post actions as this will open up a world of automation possibilities currently not available.  What on earth can I really do by just reading the quickfilters I manually added?

      Proposing:

      Create:

      POST /rest/agile/1.0/board/{boardId}/quickfilter/

      { "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }

      Required: Name, Jql

      Responds with 201 plus full quickfilter object if successful:

      { "id": <id>, "boardId": <boardId>, "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }

       

      Responds with, 400 if syntax is bad or position is impossible or Name is not unique (or even better, if jql is invalid), or 404 if boardid is not found, plus additional standard errors like 401 and 403

      If position is not specified, is added to the end of the current list.  If specified and is beyond the end of the list, error.  If specified and another filter is taking that position, insert at that position displacing the others.

      Update:
      PUT /rest/agile/1.0/board/{boardId}/quickfilter/{quickfilterid}

      { "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }

      Responds with 200 plus full quickfilter object if successful:

      { "id": <id>, "boardId": <boardId>, "name": "Bugs", "jql": "issueType = bug", "description": "Issues of type bug", "position": 0 }

       

      Responds with, 400 if syntax is bad or position is impossible or Name is not unique (or even better, if jql is invalid), or 404 if boardid is not found, plus additional standard errors like 401 and 403

      If position is not specified, it stays where it is.  If specified and is beyond the end of the list, error.  If specified and another filter is taking that position, insert at that position displacing the others.  When removed from its original position other filters shift left.

       

      Delete:

      /rest/agile/1.0/board/{boardId}/quickfilter/{quickfilterid}

      Responds with 204 if successful, 404 if not found.  Positions of remaining quickfilters shift left.

       

      Move:

      Semantics similar to "Reorder custom field options (context)"

      PUT /rest/agile/1.0/board/{boardId}/quickfilter/move

      {quickFilterIds: <Array <String>>, after: <position string>, position: <"First" | "Last">

      204 if successful
      400 if both after and position are specified, or if after refers to a bad position, or if any quickFilterIds are not found in board marked by boardId, or if a quickfilterId is listed more than once

      Other errors like 404, 401, 403 as appropriate.

       

              Unassigned Unassigned
              36959eb1aa04 Bill Bill
              Votes:
              96 Vote for this issue
              Watchers:
              46 Start watching this issue

                Created:
                Updated: