BoardApi class

Jira Software Cloud REST API documentation

Constructors

BoardApi(ApiClient _client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createBoard({required Map<String, dynamic> body}) → Future<Map<String, dynamic>>
Creates a new board. Board name, type and filter ID is required.
deleteBoard(int boardId) → Future<void>
Deletes the board. Admin without the view permission can still remove the board.
deleteBoardProperty({required String boardId, required String propertyKey}) → Future<void>
Removes the property from the board identified by the id. Ths user removing the property is required to have permissions to modify the board.
getAllBoards({int? startAt, int? maxResults, Map<String, dynamic>? type, String? name, String? projectKeyOrId, String? accountIdLocation, String? projectLocation, bool? includePrivate, bool? negateLocationFiltering, String? orderBy, String? expand, int? filterId}) → Future<Map<String, dynamic>>
Returns all boards. This only includes boards that the user has permission to view.
getAllQuickFilters({required int boardId, int? startAt, int? maxResults}) → Future<Map<String, dynamic>>
Returns all quick filters from a board, for a given board ID.
getAllSprints({required int boardId, int? startAt, int? maxResults, Map<String, dynamic>? state}) → Future
Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.
getAllVersions({required int boardId, int? startAt, int? maxResults, String? released}) → Future
Returns all versions from a board, for a given board ID. This only includes versions that the user has permission to view. Note, if the user does not have permission to view the board, no versions will be returned at all. Returned versions are ordered by the name of the project from which they belong and then by sequence defined by user.
getBoard(int boardId) → Future<Map<String, dynamic>>
Returns the board for the given board ID. This board will only be returned if the user has permission to view it. Admins without the view permission will see the board as a private one, so will see only a subset of the board's data (board location for instance).
getBoardByFilterId({int? startAt, int? maxResults, required int filterId}) → Future<Map<String, dynamic>>
Returns any boards which use the provided filter id. This method can be executed by users without a valid software license in order to find which boards are using a particular filter.
getBoardIssuesForEpic({required int boardId, required int epicId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future
Returns all issues that belong to an epic on the board, for the given epic ID and the board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
getBoardIssuesForSprint({required int boardId, required int sprintId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future
Get all issues you have access to that belong to the sprint from the board. Issue returned from this resource contains additional fields like: sprint, closedSprints, flagged and epic. Issues are returned ordered by rank. JQL order has higher priority than default rank.
getBoardProperty({required String boardId, required String propertyKey}) → Future
Returns the value of the property with a given key from the board identified by the provided id. The user who retrieves the property is required to have permissions to view the board.
getBoardPropertyKeys(String boardId) → Future
Returns the keys of all properties for the board identified by the id. The user who retrieves the property keys is required to have permissions to view the board.
getConfiguration(int boardId) → Future<Map<String, dynamic>>
Get the board configuration. The response contains the following fields:
getEpics({required int boardId, int? startAt, int? maxResults, String? done}) → Future
Returns all epics from the board, for the given board ID. This only includes epics that the user has permission to view. Note, if the user does not have permission to view the board, no epics will be returned at all.
getFeaturesForBoard(int boardId) → Future<Map<String, dynamic>>
getIssuesForBacklog({required int boardId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future<SearchResults>
Returns all issues from the board's backlog, for the given board ID. This only includes issues that the user has permission to view. The backlog contains incomplete issues that are not assigned to any future or active sprint. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
getIssuesForBoard({required int boardId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future<SearchResults>
Returns all issues from a board, for a given board ID. This only includes issues that the user has permission to view. An issue belongs to the board if its status is mapped to the board's column. Epic issues do not belongs to the scrum boards. Note, if the user does not have permission to view the board, no issues will be returned at all. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
getIssuesWithoutEpicForBoard({required int boardId, int? startAt, int? maxResults, String? jql, bool? validateQuery, List<Map<String, dynamic>>? fields, String? expand}) → Future
Returns all issues that do not belong to any epic on a board, for a given board ID. This only includes issues that the user has permission to view. Issues returned from this resource include Agile fields, like sprint, closedSprints, flagged, and epic. By default, the returned issues are ordered by rank.
getProjects({required int boardId, int? startAt, int? maxResults}) → Future
Returns all projects that are associated with the board, for the given board ID. If the user does not have permission to view the board, no projects will be returned at all. Returned projects are ordered by the name.
getProjectsFull(int boardId) → Future<void>
Returns all projects that are statically associated with the board, for the given board ID. Returned projects are ordered by the name.
getQuickFilter({required int boardId, required int quickFilterId}) → Future<Map<String, dynamic>>
Returns the quick filter for a given quick filter ID. The quick filter will only be returned if the user can view the board that the quick filter belongs to.
getReportsForBoard(int boardId) → Future<Map<String, dynamic>>
moveIssuesToBoard({required int boardId, required Map<String, dynamic> body}) → Future<void>
Move issues from the backog to the board (if they are already in the backlog of that board). This operation either moves an issue(s) onto a board from the backlog (by adding it to the issueList for the board) Or transitions the issue(s) to the first column for a kanban board with backlog. At most 50 issues may be moved at once.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setBoardProperty({required String boardId, required String propertyKey}) → Future<void>
Sets the value of the specified board's property.
toggleFeatures({required int boardId, required Map<String, dynamic> body}) → Future<Map<String, dynamic>>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited