Available since v. 1.14.* Available since v. 3.6.0 - added new REST API’s
Available since v. 3.11.0 - added new REST API
Available since v. 4.28.0 - added new REST API’s |
Available ONLY for JIRA administrators
Available ONLY for JIRA administrators
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/{JIRA_USER}
where {JIRA_USER} is JIRA user name, like admin
Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/owner/admin
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/inactiveUsers/owner
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/{JIRA_USER}
where {JIRA_USER} is JIRA user name, like admin
Example URL: {JIRA_URL}/rest/extender/1.0/agileBoard/administrator/admin
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/inactiveUsers/administrators
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/all
Response format - check Response informations
Agile Boards of this type are not visible from the GUI, because the JQL filter has been removed
If you want to restore these boards, check Change Agile Boards filter
Agile Boards of this type are not visible from the GUI, because the JQL filter has been removed
If you want to restore these boards, check Change Agile Boards filter
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/withDeletedFilter
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/withDeletedFilter
Response format - check Response informations
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/changeFilter
Request format -
Response format -
Example request:
{ "filterId": 10200, "boards": [1, 2] } |
Example response:
{ "status": "done", "message": "filter for Agile Boards has changed" } |
filterId - required - new JQL filter id for boards
boards - required - list of identifiers of boards in which the JQL filter will be replaced
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/restoreWithDeletedFilter/newFilter/{FILTER_ID}
where {FILTER_ID} is new JQL filter id
Response format -
Example response:
{ "status": "done", "message": "all boards matching your criteria have been updated" "boards": ["2345", "1", "56", "77"] } |
Method type -
URL: {JIRA_URL}/rest/extender/1.0/agileBoard/setMessage
Request format -
Response format -
Example request:
{ "message": "<span style=\"color: #FF5530;\"><span class=\"aui-icon aui-icon-small aui-iconfont-warning\"></span> Owner of this board is deactivated, please contact your administrator <a href=\"mailto:jira_admin@example.com\">jira_admin@example.com</a></span>" } |
{ "message": "Custom message - example" } |
{ "message": "" } |
Example response:
{ "status": "done" } |
{ "total": 2, "maxResults": 1000, "boards": [ { "owner": "admin", "showDaysInColumn": false, "jqlFilterId": 10003, "sprintEnabled": true, "workingDays": [ { "sunday": false, "saturday": false, "tuesday": true, "nonWorkingDays": [], "timezone": "defaultTimeZoneId", "friday": true, "thursday": true, "wednesday": true, "monday": true } ], "columns": [ { "maxInColumn": "", "minInColumn": "", "name": "To Do", "id": 1, "position": 0, "status": [ { "name": "To Do", "id": 10000, "position": 0 } ] }, { "maxInColumn": "", "minInColumn": "", "name": "In Progress", "id": 2, "position": 1, "status": [ { "name": "In Progress", "id": 3, "position": 0 } ] }, { "maxInColumn": "", "minInColumn": "", "name": "Done", "id": 3, "position": 2, "status": [ { "name": "Done", "id": 10001, "position": 0 } ] } ], "cardColor": [], "subQuery": "", "cardColorStrategy": "none", "estimation": [ { "timeTracking": "remainingEstimateAndTimeSpent", "estimationStatistic": "storyPoints" } ], "cardLayout": [ { "mode": "backlog", "id": "components", "position": 1 }, { "mode": "active sprint", "id": "assignee", "position": 0 } ], "quickFilter": [ { "query": "updatedDate >= -1d", "name": "Recently Updated", "description": "Displays issues which have been updated in the last day", "position": 1 }, { "query": "assignee = admin", "name": "Quick filter test", "description": "", "position": 0 } ], "kanbanPlanEnabled": false, "name": "Scrum board", "swimlane": [ { "default": true, "query": "", "name": "Everything Else", "description": "", "position": 0 } ], "issueDetailView": [ { "id": "status", "position": 0 }, { "id": "priority", "position": 1 }, { "id": "components", "position": 2 }, { "id": "labels", "position": 3 }, { "id": "versions", "position": 4 }, { "id": "fixVersions", "position": 5 }, { "id": "issuelinks", "position": 6 }, { "id": "reporter", "position": 7 }, { "id": "assignee", "position": 8 }, { "id": "created", "position": 9 }, { "id": "updated", "position": 10 }, { "id": "customfield_10001", "position": 11 } ], "id": 1, "jqlFilterQuery": "project = AAA ORDER BY Rank ASC", "admins": [ { "type": "user", "key": "admin" } ], "swimlaneStrategy": "epic" }, { "owner": "admin", "showDaysInColumn": true, "jqlFilterId": 10004, "sprintEnabled": false, "workingDays": [ { "sunday": false, "saturday": false, "tuesday": true, "nonWorkingDays": [ "2018-08-29" ], "timezone": "defaultTimeZoneId", "friday": true, "thursday": true, "wednesday": true, "monday": true } ], "columns": [ { "maxInColumn": "", "minInColumn": "", "name": "To Do", "id": 4, "position": 0, "status": [ { "name": "To Do", "id": 10000, "position": 0 } ] }, { "maxInColumn": "", "minInColumn": "", "name": "In Progress", "id": 5, "position": 1, "status": [ { "name": "In Progress", "id": 3, "position": 0 } ] }, { "maxInColumn": "", "minInColumn": "", "name": "Done", "id": 6, "position": 2, "status": [ { "name": "Done", "id": 10001, "position": 0 } ] } ], "cardColor": [ { "color": "#cc0000", "position": 1, "user": "unassigned" }, { "color": "#ff9933", "position": 0, "user": "admin" } ], "subQuery": "fixVersion in unreleasedVersions() OR fixVersion is EMPTY", "cardColorStrategy": "assignee", "estimation": [ { "timeTracking": "none", "estimationStatistic": "none" } ], "cardLayout": [ { "mode": "kanban", "id": "versions", "position": 1 }, { "mode": "kanban", "id": "assignee", "position": 0 } ], "quickFilter": [ { "query": "assignee = currentUser()", "name": "Only My Issues", "description": "Displays issues which are currently assigned to the current user", "position": 0 }, { "query": "updatedDate >= -1d", "name": "Recently Updated", "description": "Displays issues which have been updated in the last day", "position": 1 } ], "kanbanPlanEnabled": false, "name": "Kanban board", "swimlane": [ { "default": false, "query": "priority = Highest", "name": "Expedite", "description": "All issues with the highest priority.", "position": 0 }, { "default": true, "query": "", "name": "Everything Else", "description": "", "position": 1 } ], "issueDetailView": [ { "id": "status", "position": 0 }, { "id": "priority", "position": 1 }, { "id": "components", "position": 2 }, { "id": "labels", "position": 3 }, { "id": "versions", "position": 4 }, { "id": "fixVersions", "position": 5 }, { "id": "issuelinks", "position": 6 }, { "id": "reporter", "position": 7 }, { "id": "assignee", "position": 8 }, { "id": "created", "position": 9 }, { "id": "updated", "position": 10 }, { "id": "customfield_10001", "position": 11 } ], "id": 2, "jqlFilterQuery": "project = AAA ORDER BY Rank ASC", "admins": [ { "type": "user", "key": "admin" } ], "swimlaneStrategy": "custom" } ], "startAt": 0 } |
This REST API uses pagination to improve performance for all Jira users. Pagination is enforced for methods that could return a large collection of items. When you make a request to a paged API, the response will wrap the returned array of values in a JSON object with paging metadata, for example:
{ "startAt" : 0, "maxResults" : 10, "total": 200, "boards": [ { /* result 0 */ }, { /* result 1 */ }, { /* result 2 */ } ] } |
Where:
startAt
is the index of the first item returned in the page of results.
maxResults
is the maximum number of items that can be returned per page. Each API endpoint may have a different limit for the number of items returned, and these limits may change without notice. (default value - 1000)
total
is the total number of items contained in all pages. This number may change as the client requests the subsequent pages, therefore the client should always assume that the requested page can be empty.