Changes to the TMP board and project features endpoints

We’re working on some upgrades that will allow multiple boards per team-managed projects. In line with this, we’re rolling out some API changes that might affect you.

What is changing?

You can switch on a variety of features in Jira Software, namely:

  • Roadmap
  • Backlog
  • Board
  • Reports
  • Issue Navigator
  • Sprints
  • Estimation
  • Code
  • Releases
  • Deployments
  • On-Call
  • Project Pages

These features are now being split into two categories: Board Features and Project Features . The breakdown of categories is below:

Board Features:

  • Roadmap
  • Backlog
  • Board
  • Reports
  • Sprints
  • Estimation

Project Features:

  • Issue Navigator
  • Code
  • Releases
  • Deployments
  • On-Call
  • Project Pages

This means that the GET /rest/agile/1.0/board/{boardId}/features will soon only return board features when previously it returned all features. To get project features, use GET /rest/api/1.0/project/{projectIdOrKey}/features instead.

You can still toggle board features using PUT /rest/agile/1.0/board/{boardId}/features . However, to toggle project features, use PUT /rest/api/1.0/project/{projectIdOrKey}/features/{featureKey} instead.

We’re also deprecating the GET /rest/agile/1.0/project/{projectIdOrKey}/features endpoint.

What do I need to do?

If you are requesting project features, you’ll need to use GET /rest/api/1.0/project/{projectIdOrKey}/features instead. There are no changes to the way board features are requested.

If you relied on GET /rest/agile/1.0/board/{boardId}/features and/or the GET /rest/agile/1.0/project/{projectIdOrKey}/features to return all features, you need to make two API calls instead to get board and project features separately. You’ll then need to combine the results afterwards.

If you relied on PUT /rest/agile/1.0/board/{boardId}/features to toggle project features, you’ll need to use PUT /rest/api/1.0/project/{projectIdOrKey}/features/{featureKey} instead. There are no changes to the way board features are toggled.

By when do I need to do it?

The above changes will be rolled out to the Jira Cloud ecosystem beta group on 9 May 2022 .

1 Like