Class BacklogService

Apis related to the backlog

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-backlog

Hierarchy

CommonHttpService
- BacklogService

Index

Constructors

Methods

moveIssuesToBacklog moveIssuesToBacklogForBoard initialize

Constructors

constructor

new BacklogService(getClientInstance): BacklogService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns BacklogService
Inherited from CommonHttpService.constructor

Methods

moveIssuesToBacklog

moveIssuesToBacklog(params): Promise<void>
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
- params: {
  issueAssignRequestBean: IssueAssignRequestBean;
  }
  - issueAssignRequestBean: IssueAssignRequestBean
    Example
Returns Promise<void>
Path
POST /rest/agile/1.0/backlog/issue

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-backlog#api-rest-agile-1-0-backlog-issue-post

moveIssuesToBacklogForBoard

moveIssuesToBacklogForBoard(params): Promise<unknown>
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
- params: {
  boardId: number;
  issueRankRequestBean: IssueRankRequestBean;
  }
  - boardId: number
  - issueRankRequestBean: IssueRankRequestBean
    Example
Returns Promise<unknown>
Returns the list of issue with status of rank operation.

example:
```
{
  "entries": [
    {
      "issueId": 10000,
      "issueKey": "PR-1",
      "status": 200
    },
    {
      "issueId": 10001,
      "issueKey": "PR-2",
      "status": 200
    },
    {
      "errors": [
        "JIRA Agile cannot execute the rank operation at this time. Please try again later."
      ],
      "issueId": 10002,
      "issueKey": "PR-3",
      "status": 503
    }
  ]
}
```
Path
POST /rest/agile/1.0/backlog/{boardId}/issue

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-backlog#api-rest-agile-1-0-backlog-boardid-issue-post

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize