REST API - Jira Data Center

When replacing parameters indicated by <PARAMETER_NAME>, be sure to remove the ‘<' '>’ characters as well.

For example:

<active_only> replaced by true or false

Authorization

In Capacity Tracker 1.1.30, the API authorization method was changed to use custom API keys in order to consolidate our cloud & DC versions. Unfortunately, this caused some issues on some of our client custom setups (mainly related to SSO).

Starting from 1.1.31, we are reverting back to using Basic Auth or Personal Access Tokens for the DC version.

In addition, we are introducing a new Global Permission to control who can use the REST API.

You have two options:
1. Basic Auth
2. Personal Access Tokens

Endpoints

Get capacity report

Returns the capacity report for a specific work period. In case none were specified, the most recent active one will be used.

Method	Endpoint

Method	Endpoint
GET	`https://<my_jira_url>/rest/capacity-tracker/latest/public/api/v1/capacity-report/board/<my_board_id>?workPeriodId=<my_work_period_id>`

Parameter	Type	Required	Default Value	Description

Parameter	Type	Required	Default Value	Description
<board_id>	Number	Yes		ID of your Jira Board (or RapidView).
<my_work_period_id>	Number	No	0	ID of your sprint or version.

Get consolidated capacity report

Returns the consolidated capacity report including all work periods.

Method	Endpoint

Method	Endpoint
GET	`https://<my_jira_url>/rest/capacity-tracker/latest/public/api/v1/capacity-report/board/<my_board_id>/consolidated?activeOnly=<active_only>`

Parameter	Type	Required	Default Value	Description

Parameter	Type	Required	Default Value	Description
<board_id>	Number	Yes		ID of your Jira Board (or RapidView).
<active_only>	Boolean	No	false	Only return active work periods (i.e. future work periods will not be included in the results).

Get consolidated capacity report (flat)

Returns the consolidated capacity report including all work periods in a flat schema (the report will be returned as a list of records with all necessary columns instead of a nested JSON object).

This call is mostly used to integrate with Excel/PowerBI.

Method	Endpoint

Method	Endpoint
GET	`https://<my_jira_url>/rest/capacity-tracker/latest/public/api/v1/capacity-report/board/<my_board_id>/consolidated-flat?activeOnly=<active_only>&includeUnassigned=<include_unassigned>&filterDaysOff=<filter_days_off>`

Parameter	Type	Required	Default Value	Description

Parameter	Type	Required	Default Value	Description
<board_id>	Number	Yes		ID of your Jira Board (or RapidView).
<active_only>	Boolean	No	false	Only return active work periods (i.e. future work periods will not be included in the results).
<include_unassigned>	Boolean	No	false	Include unassigned issues in your capacity report.
<filter_days_off>	Boolean	No	false	Filter days off based on the work period start/end dates. By default, all days off are returned even if they are outside the work period date ranges.

Get user days off

Returns the full list of user days off.

Method	Endpoint

Method	Endpoint
GET

Update user days off

Updates the user days off directly without using the Capacity Tracker UI.

Method	Endpoint	Request Body

Method

Endpoint

Request Body

PUT

Capacity Tracker supports two different kinds of days off:

Full day

or

Half day

Two modes are supported:

Set

This mode will completely replace the days off for the given user account IDs (all existing days off will be removed).

Add / remove

This mode will always execute the operations in this order: Remove, then Add.

Remove
- The given days off will be removed for the specific account IDs.
- Removing a full day will also remove a half day.
- Attempting to remove a half day when a full day was previously stored will be ignored.
Add
- The given days off will be added for the specific account IDs.
- Note: this behaves like a partial set. For example, if a user has a full day off on 2023-05-01 but you are adding a half day (2023-05-01 H), the full day will be replaced by the half day.