Board
Get configuration
Changed onGet the board configuration. The response contains the following fields:
- id - ID of the board.
- name - Name of the board.
- filter - Reference to the filter used by the given board.
- location - Reference to the container that the board is located in. Includes the container type (Valid values: project, user).
- subQuery (Kanban only) - JQL subquery used by the given board.
- columnConfig - The column configuration lists the columns for the board, in the order defined in the column configuration. For each column, it shows the issue status mapping as well as the constraint type (Valid values: none, issueCount, issueCountExclSubs) for the min/max number of issues. Note, the last column with statuses mapped to it is treated as the "Done" column, which means that issues in that column will be marked as already completed.
- estimation (Scrum only) - Contains information about type of estimation used for the board. Valid values: none, issueCount, field. If the estimation type is "field", the ID and display name of the field used for estimation is also returned. Note, estimates for an issue can be updated by a PUT /rest/api/3/issue/{issueIdOrKey} request, however the fields must be on the screen. "timeoriginalestimate" field will never be on the screen, so in order to update it "originalEstimate" in "timetracking" field should be updated.
- ranking - Contains information about custom field used for ranking in the given board.
get/rest/agile/1.0/board/{boardId}/configuration
Request
- Base URLhttps://your-domain.atlassian.net
- URLhttps://your-domain.atlassian.net/rest/agile/1.0/board/{boardId}/configuration
- Auth
- HTTP basic
- or OAuth 2Authorization code: https://auth.atlassian.com/authorizeToken URL: https://auth.atlassian.com/oauth/token scopes: read:board-scope.admin:jira-software, read:project:jira
Path parameters
boardIdinteger required
The ID of the board for which configuration is requested.
Response
Returns the configuration of the board for given boardId.
Changes
- info
the endpoint scheme security
basicAuthwas added to the API
- info
- info
endpoint added
- info