Class: AgileBacklogClient

AgileBacklogClient(jiraClient)

new AgileBacklogClient(jiraClient)

Used to access Jira REST endpoints in '/rest/agile/1.0/backlog'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

moveIssuesToBacklog(opts, callbackopt) → {Promise}

Move issues to the backlog. This operation is equivalent to remove future and active sprints from a given set of issues. At most 50 issues may be moved at once.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API.

Properties
Name Type Attributes Description
issues <optional>

Array of strings with issues keys or ids
callback <optional>

Called when the dashboard has been retrieved
Source:
Returns:

Resolved when the dashboard has been retrieved

Type
Promise

moveIssuesToBacklogForBoard(opts, callbackopt) → {Promise}

Move issues to the backlog of a particular board (if they are already on that board). This operation is equivalent to remove future and active sprints from a given set of issues if the board has sprints If the board does not have sprints this will put the issues back into the backlog from the board. At most 50 issues may be moved at once.

Parameters:
Name Type Attributes Description
opts

The request options sent to the Jira API.

Properties
Name Type Attributes Description
boardId

The agile board id.
issues <optional>

Array of strings with issues keys or ids
rankBeforeIssue <optional>

string
rankAfterIssue <optional>

string
rankCustomFieldId <optional>

int64
callback <optional>

Called when the dashboard has been retrieved
Source:
Returns:

Resolved when the dashboard has been retrieved

Type
Promise