Additional Backlog column returned from API

Jira Development Jira Cloud
, , ,
1

Hello
When I use /rest/agile/1.0/board/${jiraBoardId}/configuration API to get kanban type configuration I always get additional Backlog column with no statuses. It looks like:

"columnConfig": {
		"columns": [{
			"name": "Backlog",
			"statuses": []
		}, {
(...)

There is no such column on the board. I know there is Kanban backlog idea idea but for the board I’m checking it, kanban backlog is not enabled.

Seems as not a problem, but I have a board with regular column called Backlog and from that board the API returns me 2 backlog columns.

Is this as designed behaviour or Backlog should not be returned when not enabled?

2

I have exactly the same behavior.
Do you find more explanations? A workaround?

3

Unfortunately no :(.

4

hello @dlaize and @ZbigniewPiecuch

In a Scrum board, the issue state of being in the Backlog is used to show those issues in the thing on the GUI called the Backlog. However, on a default Kanban board, there is no visible Backlog, so those issues in that state get mixed in with the other issues in the Kanban view’s To Do column… but you still need to retain the mechanism to be able to differentiate those issues with that state so that if your board admin decides to turn on the Kanban backlog, it can work correctly.

Yes, there is no vertical column with the name ‘Backlog’ that you can configure on a default Kanban board, but it’s there, silently in the background, waiting to be used. So, when your query to the Board configuration endpoint for a board of the type Kanban returns a column called Backlog, you know that it’s not a ‘real’ column, just a placeholder and you can just ignore it.

1 Like
5

Thank you @sunnyape for this explanation. Appreciate.

The way I dit it:

Blockquote
resultValue = columnConfig.columns
.filter((x) => x.statuses.length > 0)

6

Thank @sunnyape, that makes sense. Just complicates a little bit when there is real column called Backlog.

@dlaize just please take into account, that in Jira Software columns without statuses are allowed in boards’ configuration, though they are not displayed on the board view. So if you need also those columns without statuses assigned, your code can cause you troubles.

7

Hmmm, I never thought of that. Indeed, if you wanted, you could name all your Kanban board columns ‘Backlog’ and Jira wouldn’t stop you. If they had no status either, they would indeed disappear from view on the board but be returned via the REST API call, and you’d be unable to differentiate them from the default hidden Backlog column:

"columns": [
  {
   "name": "Backlog",
   "statuses": []
  },
  {
   "name": "Backlog",
   "statuses": []
  },
  {
   "name": "Backlog",
   "statuses": []
  }
 ]

There’s only so much the REST API can advise you of in anticipation of the obscure :slight_smile:

8

I want to track issues by column.
To do that, I check issues by status.

So… I think it’s ok for my use case.

But yes, it could be wrong for other usages

1 Like