Class BoardService

Apis related to boards

See

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

Hierarchy

CommonHttpService
- BoardService

Constructors

constructor

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

Methods

createBoard

createBoard(params): Promise<Board>
Creates a new board. Board name, type and filter ID is required.
- name - Must be less than 255 characters.
- type - Valid values: scrum, kanban
- filterId - ID of a filter that the user has permissions to view. Note, if the user does not have the 'Create shared objects' permission and tries to create a shared board, a private board will be created instead (remember that board sharing depends on the filter sharing).
- location - The container that the board will be located in. location must include the type property (Valid values: project, user). If choosing 'project', then a project must be specified by a projectKeyOrId property in location. If choosing 'user', the current user is chosen by default. The projectKeyOrId property should not be provided.
Note:
- If you want to create a new project with an associated board, use the Jira platform REST API. For more information, see the Create project method. The projectTypeKey for software boards must be 'software' and the projectTemplateKey must be either com.pyxis.greenhopper.jira:gh-kanban-template or com.pyxis.greenhopper.jira:gh-scrum-template.
- You can create a filter using the Jira REST API. For more information, see the Create filter method.
- If you do not ORDER BY the Rank field for the filter of your board, you will not be able to reorder issues on the board.
Parameters
- params: {
  boardCreateBean: BoardCreateBean;
  }
  - boardCreateBean: BoardCreateBean
    Example
Returns Promise<Board>
Returns the created board.

example:
```
{
  "id": 84,
  "name": "scrum board",
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
  "type": "scrum"
}
```
Path
POST /rest/agile/1.0/board

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

deleteBoard

deleteBoard(params): Promise<void>
Deletes the board. Admin without the view permission can still remove the board.
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
    ID of the board to be deleted
Returns Promise<void>
Path
DELETE /rest/agile/1.0/board/{boardId}

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

deleteBoardProperty

deleteBoardProperty(params): Promise<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.
Parameters
- params: {
  boardId: string;
  propertyKey: string;
  }
  - boardId: string
    the id of the board from which the property will be removed.
  - propertyKey: string
    the key of the property to remove.
Returns Promise<void>
Path
DELETE /rest/agile/1.0/board/{boardId}/properties/{propertyKey}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-delete

getAllBoards

getAllBoards(params?): Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: Board[];
} & {
    [key: string]: unknown;
}>
Returns all boards. This only includes boards that the user has permission to view.

Deprecation notice: The required OAuth 2.0 scopes will be updated on February 15, 2024.
- read:board-scope:jira-software, read:project:jira
Parameters
- params: {
      accountIdLocation?: string;
      expand?: string;
      filterId?: number;
      includePrivate?: boolean;
      maxResults?: number;
      name?: string;
      negateLocationFiltering?: boolean;
      orderBy?: "name" | "-name" | "+name";
      projectKeyOrId?: string;
      projectLocation?: string;
      projectTypeLocation?: string[];
      startAt?: number;
      type?: {};
  } = {}
  - OptionalaccountIdLocation?: string
  - Optionalexpand?: string
    List of fields to expand for each board. Valid values: admins, permissions.
  - OptionalfilterId?: number
    Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
  - OptionalincludePrivate?: boolean
    Appends private boards to the end of the list. The name and type fields are excluded for security reasons.
  - OptionalmaxResults?: number
    The maximum number of boards to return per page. See the 'Pagination' section at the top of this page for more details.
  - Optionalname?: string
    Filters results to boards that match or partially match the specified name.
  - OptionalnegateLocationFiltering?: boolean
    If set to true, negate filters used for querying by location. By default false.
  - OptionalorderBy?: "name" | "-name" | "+name"
    Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name.
  - OptionalprojectKeyOrId?: string
    Filters results to boards that are relevant to a project. Relevance means that the jql filter defined in board contains a reference to a project.
  - OptionalprojectLocation?: string
  - OptionalprojectTypeLocation?: string[]
    Filters results to boards that are relevant to a project types. Support Jira Software, Jira Service Management. Valid values: software, service_desk. By default software.
  - OptionalstartAt?: number
    The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
  - Optionaltype?: {}
    Filters results to boards of the specified types. Valid values: scrum, kanban, simple.
Returns Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: Board[];
} & {
    [key: string]: unknown;
}>
Returns the requested boards, at the specified page of the results.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "id": 84,
      "name": "scrum board",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
      "type": "scrum"
    },
    {
      "id": 92,
      "name": "kanban board",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92",
      "type": "kanban"
    }
  ]
}
```
Path
GET /rest/agile/1.0/board

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-get

getAllQuickFilters

getAllQuickFilters(params): Promise<PageBeanQuickFilterBean>
Returns all quick filters from a board, for a given board ID.
Parameters
- params: {
      boardId: number;
      maxResults?: number;
      startAt?: number;
  }
  - boardId: number
    The ID of the board that contains the requested quick filters.
  - OptionalmaxResults?: number
    The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    The starting index of the returned quick filters. Base index: 0. See the 'Pagination' section at the top of this page for more details.
Returns Promise<PageBeanQuickFilterBean>
Returns the requested quick filters, at the specified page of the results. Quick filters will be ordered first by position.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "boardId": 1,
      "description": "Issues of type bug",
      "id": 1,
      "jql": "issueType = bug",
      "name": "Bugs",
      "position": 0
    },
    {
      "boardId": 1,
      "description": "Issues of type task",
      "id": 2,
      "jql": "issueType = task",
      "name": "Tasks",
      "position": 0
    }
  ]
}
```
Path
GET /rest/agile/1.0/board/{boardId}/quickfilter

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-get

getAllSprints

getAllSprints(params): Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: SprintBean[];
} & {
    [key: string]: unknown;
}>
Returns all sprints from a board, for a given board ID. This only includes sprints that the user has permission to view.
Parameters
- params: {
      boardId: number;
      maxResults?: number;
      startAt?: number;
      state?: {};
  }
  - boardId: number
    The ID of the board that contains the requested sprints.
  - OptionalmaxResults?: number
    The maximum number of sprints to return per page. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    The starting index of the returned sprints. Base index: 0. See the 'Pagination' section at the top of this page for more details.
  - Optionalstate?: {}
    Filters results to sprints in specified states. Valid values: future, active, closed. You can define multiple states separated by commas, e.g. state=active,closed
Returns Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: SprintBean[];
} & {
    [key: string]: unknown;
}>
Returns the requested sprints, at the specified page of the results. Sprints will be ordered first by state (i.e. closed, active, future) then by their position in the backlog.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "id": 37,
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
      "state": "closed",
      "name": "sprint 1",
      "startDate": "2015-04-11T15:22:00.000+10:00",
      "endDate": "2015-04-20T01:22:00.000+10:00",
      "completeDate": "2015-04-20T11:04:00.000+10:00",
      "originBoardId": 5,
      "goal": "sprint 1 goal"
    },
    {
      "id": 72,
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/73",
      "state": "future",
      "name": "sprint 2",
      "goal": "sprint 2 goal"
    }
  ]
}
```
Path
GET /rest/agile/1.0/board/{boardId}/sprint

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-get

getAllVersions

getAllVersions(params): Promise<unknown>
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.
Parameters
- params: {
      boardId: number;
      maxResults?: number;
      released?: string;
      startAt?: number;
  }
  - boardId: number
    The ID of the board that contains the requested versions.
  - OptionalmaxResults?: number
    The maximum number of versions to return per page. See the 'Pagination' section at the top of this page for more details.
  - Optionalreleased?: string
    Filters results to versions that are either released or unreleased. Valid values: true, false.
  - OptionalstartAt?: number
    The starting index of the returned versions. Base index: 0. See the 'Pagination' section at the top of this page for more details.
Returns Promise<unknown>
Returns the requested versions, at the specified page of the results.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "archived": false,
      "description": "A first version",
      "id": 10000,
      "name": "Version 1",
      "projectId": 10000,
      "releaseDate": "2015-04-20T01:02:00.000+10:00",
      "released": true,
      "self": "https://your-domain.atlassian.net/version/10000"
    },
    {
      "archived": false,
      "description": "Minor Bugfix version",
      "id": 10010,
      "name": "Next Version",
      "projectId": 10000,
      "released": false,
      "self": "https://your-domain.atlassian.net/version/10010"
    }
  ]
}
```
Path
GET /rest/agile/1.0/board/{boardId}/version

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-version-get

getBoard

getBoard(params): Promise<Board>
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).
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
    The ID of the requested board.
Returns Promise<Board>
Returns the requested board.

example:
```
{
  "id": 84,
  "location": {
    "displayName": "Example Project",
    "name": "Example Project",
    "projectId": 10040,
    "projectKey": "Example Project Key",
    "projectName": "Example Project",
    "projectTypeKey": "KEY",
    "userAccountId": "5b10a2844c20165700ede21g",
    "userId": 10040
  },
  "name": "scrum board",
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84",
  "type": "scrum"
}
```
Path
GET /rest/agile/1.0/board/{boardId}

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

getBoardByFilterId

getBoardByFilterId(params): Promise<{
    isLast?: boolean;
    maxResults?: number;
    startAt?: number;
    total?: number;
    values?: BoardFilterBean[];
}>
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.
Parameters
- params: {
      filterId: number;
      maxResults?: number;
      startAt?: number;
  }
  - filterId: number
    Filters results to boards that are relevant to a filter. Not supported for next-gen boards.
  - OptionalmaxResults?: number
    The maximum number of boards to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for more details.
Returns Promise<{
    isLast?: boolean;
    maxResults?: number;
    startAt?: number;
    total?: number;
    values?: BoardFilterBean[];
}>
Returns the requested boards, at the specified page of the results.

example:
```
{
  "id": 84,
  "name": "scrum board",
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84"
}
```
Path
GET /rest/agile/1.0/board/filter/{filterId}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-filter-filterid-get

getBoardIssuesForEpic

getBoardIssuesForEpic(params): Promise<unknown>

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.

Parameters

params: {
    boardId: number;
    epicId: number;
    expand?: string;
    fields?: {}[];
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}
- boardId: number
  The ID of the board that contains the requested issues.
- epicId: number
  The ID of the epic that contains the requested issues.
- Optionalexpand?: string
  A comma-separated list of the parameters to expand.
- Optionalfields?: {}[]
  The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
- Optionaljql?: string
  Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues.
- OptionalmaxResults?: number
  The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.
- OptionalstartAt?: number
  The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- OptionalvalidateQuery?: boolean
  Specifies whether to validate the JQL query or not. Default: true.

Returns Promise<unknown>

Returns the requested issues, at the specified page of the results.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "flagged": true,
        "sprint": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
          "state": "future",
          "name": "sprint 2",
          "goal": "sprint 2 goal"
        },
        "closedSprints": [
          {
            "id": 37,
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
            "state": "closed",
            "name": "sprint 1",
            "startDate": "2015-04-11T15:22:00.000+10:00",
            "endDate": "2015-04-20T01:22:00.000+10:00",
            "completeDate": "2015-04-20T11:04:00.000+10:00",
            "goal": "sprint 1 goal"
          }
        ],
        "description": "example bug report",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "epic": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
          "name": "epic 1",
          "summary": "epic 1 summary",
          "color": {
            "key": "color_4"
          },
          "done": true
        },
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10001",
      "key": "HSP-1",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-epicid-issue-get

getBoardIssuesForSprint

getBoardIssuesForSprint(params): Promise<unknown>

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.

Parameters

params: {
    boardId: number;
    expand?: string;
    fields?: {}[];
    jql?: string;
    maxResults?: number;
    sprintId: number;
    startAt?: number;
    validateQuery?: boolean;
}
- boardId: number
  The ID of the board that contains requested issues.
- Optionalexpand?: string
  A comma-separated list of the parameters to expand.
- Optionalfields?: {}[]
  The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
- Optionaljql?: string
  Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
- OptionalmaxResults?: number
  The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.
- sprintId: number
  The ID of the sprint that contains requested issues.
- OptionalstartAt?: number
  The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- OptionalvalidateQuery?: boolean
  Specifies whether to validate the JQL query or not. Default: true.

Returns Promise<unknown>

Returns the requested issues, at the specified page of the results.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "flagged": true,
        "sprint": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
          "state": "future",
          "name": "sprint 2",
          "goal": "sprint 2 goal"
        },
        "closedSprints": [
          {
            "id": 37,
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
            "state": "closed",
            "name": "sprint 1",
            "startDate": "2015-04-11T15:22:00.000+10:00",
            "endDate": "2015-04-20T01:22:00.000+10:00",
            "completeDate": "2015-04-20T11:04:00.000+10:00",
            "goal": "sprint 1 goal"
          }
        ],
        "description": "example bug report",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "epic": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
          "name": "epic 1",
          "summary": "epic 1 summary",
          "color": {
            "key": "color_4"
          },
          "done": true
        },
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10001",
      "key": "HSP-1",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-sprint-sprintid-issue-get

getBoardProperty

getBoardProperty(params): Promise<unknown>
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.
Parameters
- params: {
  boardId: string;
  propertyKey: string;
  }
  - boardId: string
    the ID of the board from which the property will be returned.
  - propertyKey: string
    the key of the property to return.
Returns Promise<unknown>
Returned if the board exists and the property was found.

Path
GET /rest/agile/1.0/board/{boardId}/properties/{propertyKey}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-get

getBoardPropertyKeys

getBoardPropertyKeys(params): Promise<unknown>
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.
Parameters
- params: {
  boardId: string;
  }
  - boardId: string
    the ID of the board from which property keys will be returned.
Returns Promise<unknown>
Returned if the board with given id exists.

Path
GET /rest/agile/1.0/board/{boardId}/properties

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-get

getConfiguration

getConfiguration(params): Promise<BoardConfigBean>
Get 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.
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
    The ID of the board for which configuration is requested.
Returns Promise<BoardConfigBean>
Returns the configuration of the board for given boardId.

example:
```
{
  "columnConfig": {
    "columns": [
      {
        "name": "To Do",
        "statuses": [
          {
            "id": "1",
            "self": "https://your-domain.atlassian.net/status/1"
          },
          {
            "id": "4",
            "self": "https://your-domain.atlassian.net/status/4"
          }
        ]
      },
      {
        "max": 4,
        "min": 2,
        "name": "In progress",
        "statuses": [
          {
            "id": "3",
            "self": "https://your-domain.atlassian.net/status/3"
          }
        ]
      },
      {
        "name": "Done",
        "statuses": [
          {
            "id": "5",
            "self": "https://your-domain.atlassian.net/status/5"
          }
        ]
      }
    ],
    "constraintType": "issueCount"
  },
  "estimation": {
    "field": {
      "displayName": "Story Points",
      "fieldId": "customfield_10002"
    },
    "type": "field"
  },
  "filter": {
    "id": "1001",
    "self": "https://your-domain.atlassian.net/filter/1001"
  },
  "id": 10000,
  "location": {
    "id": "10010",
    "key": "PROJ",
    "name": "name",
    "self": "https://your-domain.atlassian.net/rest/api/3/project/10010",
    "type": "project"
  },
  "name": "Board",
  "ranking": {
    "rankCustomFieldId": 10020
  },
  "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/84/config"
}
```
Path
GET /rest/agile/1.0/board/{boardId}/configuration

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-configuration-get

getEpics

getEpics(params): Promise<unknown>
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.
Parameters
- params: {
      boardId: number;
      done?: string;
      maxResults?: number;
      startAt?: number;
  }
  - boardId: number
    The ID of the board that contains the requested epics.
  - Optionaldone?: string
    Filters results to epics that are either done or not done. Valid values: true, false.
  - OptionalmaxResults?: number
    The maximum number of epics to return per page. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    The starting index of the returned epics. Base index: 0. See the 'Pagination' section at the top of this page for more details.
Returns Promise<unknown>
Returns the requested epics, at the specified page of the results.

example:
```
{
  "isLast": false,
  "maxResults": 2,
  "startAt": 1,
  "total": 5,
  "values": [
    {
      "id": 37,
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
      "name": "epic 1",
      "summary": "epic 1 summary",
      "color": {
        "key": "color_4"
      },
      "done": true
    },
    {
      "id": 37,
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/13",
      "name": "epic 2",
      "summary": "epic 2 summary",
      "color": {
        "key": "color_2"
      },
      "done": false
    }
  ]
}
```
Path
GET /rest/agile/1.0/board/{boardId}/epic

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-get

getFeaturesForBoard

getFeaturesForBoard(params): Promise<FeatureResponseBean>
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
Returns Promise<FeatureResponseBean>
200 response

Path
GET /rest/agile/1.0/board/{boardId}/features

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-get

getIssuesForBacklog

getIssuesForBacklog(params): Promise<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.

Parameters

params: {
    boardId: number;
    expand?: string;
    fields?: {}[];
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}
- boardId: number
  The ID of the board that has the backlog containing the requested issues.
- Optionalexpand?: string
  This parameter is currently not used.
- Optionalfields?: {}[]
  The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
- Optionaljql?: string
  Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
- OptionalmaxResults?: number
  The maximum number of issues to return per page. Default: 50. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.
- OptionalstartAt?: number
  The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- OptionalvalidateQuery?: boolean
  Specifies whether to validate the JQL query or not. Default: true.

Returns Promise<SearchResults>

Returns the requested issues, at the specified page of the results.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "flagged": true,
        "sprint": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
          "state": "future",
          "name": "sprint 2",
          "goal": "sprint 2 goal"
        },
        "closedSprints": [
          {
            "id": 37,
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
            "state": "closed",
            "name": "sprint 1",
            "startDate": "2015-04-11T15:22:00.000+10:00",
            "endDate": "2015-04-20T01:22:00.000+10:00",
            "completeDate": "2015-04-20T11:04:00.000+10:00",
            "goal": "sprint 1 goal"
          }
        ],
        "description": "example bug report",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "epic": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
          "name": "epic 1",
          "summary": "epic 1 summary",
          "color": {
            "key": "color_4"
          },
          "done": true
        },
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10001",
      "key": "HSP-1",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/agile/1.0/board/{boardId}/backlog

See

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

getIssuesForBoard

getIssuesForBoard(params): Promise<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.

Parameters

params: {
    boardId: number;
    expand?: string;
    fields?: {}[];
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}
- boardId: number
  The ID of the board that contains the requested issues.
- Optionalexpand?: string
  This parameter is currently not used.
- Optionalfields?: {}[]
  The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
- Optionaljql?: string
  Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
- OptionalmaxResults?: number
  The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.
- OptionalstartAt?: number
  The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- OptionalvalidateQuery?: boolean
  Specifies whether to validate the JQL query or not. Default: true.

Returns Promise<SearchResults>

Returns the requested issues, at the specified page of the results.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "flagged": true,
        "sprint": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
          "state": "future",
          "name": "sprint 2",
          "goal": "sprint 2 goal"
        },
        "closedSprints": [
          {
            "id": 37,
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
            "state": "closed",
            "name": "sprint 1",
            "startDate": "2015-04-11T15:22:00.000+10:00",
            "endDate": "2015-04-20T01:22:00.000+10:00",
            "completeDate": "2015-04-20T11:04:00.000+10:00",
            "goal": "sprint 1 goal"
          }
        ],
        "description": "example bug report",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "epic": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
          "name": "epic 1",
          "summary": "epic 1 summary",
          "color": {
            "key": "color_4"
          },
          "done": true
        },
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10001",
      "key": "HSP-1",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/agile/1.0/board/{boardId}/issue

See

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

getIssuesWithoutEpicForBoard

getIssuesWithoutEpicForBoard(params): Promise<unknown>

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.

Parameters

params: {
    boardId: number;
    expand?: string;
    fields?: {}[];
    jql?: string;
    maxResults?: number;
    startAt?: number;
    validateQuery?: boolean;
}
- boardId: number
  The ID of the board that contains the requested issues.
- Optionalexpand?: string
  A comma-separated list of the parameters to expand.
- Optionalfields?: {}[]
  The list of fields to return for each issue. By default, all navigable and Agile fields are returned.
- Optionaljql?: string
  Filters results using a JQL query. If you define an order in your JQL query, it will override the default order of the returned issues. Note that username and userkey can't be used as search terms for this parameter due to privacy reasons. Use accountId instead.
- OptionalmaxResults?: number
  The maximum number of issues to return per page. See the 'Pagination' section at the top of this page for more details. Note, the total number of issues returned is limited by the property 'jira.search.views.default.max' in your Jira instance. If you exceed this limit, your results will be truncated.
- OptionalstartAt?: number
  The starting index of the returned issues. Base index: 0. See the 'Pagination' section at the top of this page for more details.
- OptionalvalidateQuery?: boolean
  Specifies whether to validate the JQL query or not. Default: true.

Returns Promise<unknown>

Returns the requested issues, at the specified page of the results.

example:

{
  "expand": "names,schema",
  "issues": [
    {
      "expand": "",
      "fields": {
        "flagged": true,
        "sprint": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/13",
          "state": "future",
          "name": "sprint 2",
          "goal": "sprint 2 goal"
        },
        "closedSprints": [
          {
            "id": 37,
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/23",
            "state": "closed",
            "name": "sprint 1",
            "startDate": "2015-04-11T15:22:00.000+10:00",
            "endDate": "2015-04-20T01:22:00.000+10:00",
            "completeDate": "2015-04-20T11:04:00.000+10:00",
            "goal": "sprint 1 goal"
          }
        ],
        "description": "example bug report",
        "project": {
          "avatarUrls": {
            "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
            "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
            "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
            "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
          },
          "id": "10000",
          "insight": {
            "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
            "totalIssueCount": 100
          },
          "key": "EX",
          "name": "Example",
          "projectCategory": {
            "description": "First Project Category",
            "id": "10000",
            "name": "FIRST",
            "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
          },
          "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
          "simplified": false,
          "style": "classic"
        },
        "comment": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "body": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
                    }
                  ]
                }
              ]
            },
            "created": "2021-01-17T12:34:00.000+0000",
            "id": "10000",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "Administrators",
              "type": "role",
              "value": "Administrators"
            }
          }
        ],
        "epic": {
          "id": 37,
          "self": "https://your-domain.atlassian.net/rest/agile/1.0/epic/23",
          "name": "epic 1",
          "summary": "epic 1 summary",
          "color": {
            "key": "color_4"
          },
          "done": true
        },
        "worklog": [
          {
            "author": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "comment": {
              "type": "doc",
              "version": 1,
              "content": [
                {
                  "type": "paragraph",
                  "content": [
                    {
                      "type": "text",
                      "text": "I did some work here."
                    }
                  ]
                }
              ]
            },
            "id": "100028",
            "issueId": "10002",
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
            "started": "2021-01-17T12:34:00.000+0000",
            "timeSpent": "3h 20m",
            "timeSpentSeconds": 12000,
            "updateAuthor": {
              "accountId": "5b10a2844c20165700ede21g",
              "active": false,
              "displayName": "Mia Krystof",
              "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
            },
            "updated": "2021-01-18T23:45:00.000+0000",
            "visibility": {
              "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
              "type": "group",
              "value": "jira-developers"
            }
          }
        ],
        "updated": 1,
        "timetracking": {
          "originalEstimate": "10m",
          "originalEstimateSeconds": 600,
          "remainingEstimate": "3m",
          "remainingEstimateSeconds": 200,
          "timeSpent": "6m",
          "timeSpentSeconds": 400
        }
      },
      "id": "10001",
      "key": "HSP-1",
      "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/92/issue/10001"
    }
  ],
  "maxResults": 50,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/agile/1.0/board/{boardId}/epic/none/issue

See

https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-epic-none-issue-get

getProjects

getProjects(params): Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: ProjectDetails[];
} & {
    [key: string]: unknown;
}>
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.

A project is associated with a board if the board filter contains reference the project or there is an issue from the project that belongs to the board.

The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query project in (ABC, BCD) AND reporter = admin have reference to ABC and BCD projects but query project in (ABC, BCD) OR reporter = admin doesn't have reference to any project.

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.
Parameters
- params: {
      boardId: number;
      maxResults?: number;
      startAt?: number;
  }
  - boardId: number
    The ID of the board that contains returned projects.
  - OptionalmaxResults?: number
    The maximum number of projects to return per page. See the 'Pagination' section at the top of this page for more details.
  - OptionalstartAt?: number
    The starting index of the returned projects. Base index: 0. See the 'Pagination' section at the top of this page for more details.
Returns Promise<{
    expand?: string;
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total?: number;
    values: ProjectDetails[];
} & {
    [key: string]: unknown;
}>
Returns the board's projects, at the specified page of the results.

example:
```
{
  "isLast": true,
  "maxResults": 10,
  "startAt": 0,
  "total": 2,
  "values": [
    {
      "avatarUrls": {
        "16x16": "secure/projectavatar?size=xsmall&pid=10000",
        "24x24": "secure/projectavatar?size=small&pid=10000",
        "32x32": "secure/projectavatar?size=medium&pid=10000",
        "48x48": "secure/projectavatar?size=large&pid=10000"
      },
      "id": "10000",
      "key": "EX",
      "name": "Example",
      "projectCategory": {
        "description": "Project category description",
        "id": "10000",
        "name": "A project category"
      },
      "projectTypeKey": "ProjectTypeKey{key='software'}",
      "self": "project/EX",
      "simplified": false
    }
  ]
}
```
Path
GET /rest/agile/1.0/board/{boardId}/project

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-get

getProjectsFull

getProjectsFull(params): Promise<void>
Returns all projects that are statically associated with the board, for the given board ID. Returned projects are ordered by the name.

A project is associated with a board if the board filter contains reference the project.

The board filter contains reference the project only if JQL query guarantees that returned issues will be returned from the project set defined in JQL. For instance the query project in (ABC, BCD) AND reporter = admin have reference to ABC and BCD projects but query project in (ABC, BCD) OR reporter = admin doesn't have reference to any project.
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
    The ID of the board that contains returned projects.
Returns Promise<void>
Path
GET /rest/agile/1.0/board/{boardId}/project/full

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-project-full-get

getQuickFilter

getQuickFilter(params): Promise<QuickFilterBean>
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.
Parameters
- params: {
  boardId: number;
  quickFilterId: number;
  }
  - boardId: number
  - quickFilterId: number
    The ID of the requested quick filter.
Returns Promise<QuickFilterBean>
Returns the requested quick filter.

example:
```
{
  "boardId": 1,
  "description": "Issues of type bug",
  "id": 1,
  "jql": "issueType = bug",
  "name": "Bugs",
  "position": 0
}
```
Path
GET /rest/agile/1.0/board/{boardId}/quickfilter/{quickFilterId}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-quickfilter-quickfilterid-get

getReportsForBoard

getReportsForBoard(params): Promise<ReportsResponseBean>
Parameters
- params: {
  boardId: number;
  }
  - boardId: number
Returns Promise<ReportsResponseBean>
200 response

Path
GET /rest/agile/1.0/board/{boardId}/reports

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-reports-get

moveIssuesToBoard

moveIssuesToBoard(params): Promise<PartialSuccessBean>
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.
Parameters
- params: {
  boardId: number;
  issueRankRequestBean: IssueRankRequestBean;
  }
  - boardId: number
  - issueRankRequestBean: IssueRankRequestBean
    Example
Returns Promise<PartialSuccessBean>
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/board/{boardId}/issue

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

setBoardProperty

setBoardProperty(params): Promise<{
body: unknown;
created: boolean;
}>
Sets the value of the specified board's property.

You can use this resource to store a custom data against the board identified by the id. The user who stores the data is required to have permissions to modify the board.
Parameters
- params: {
      boardId: string;
      propertyKey: string;
      requestBody: unknown;
  }
  - boardId: string
    the ID of the board on which the property will be set.
  - propertyKey: string
    the key of the board's property. The maximum length of the key is 255 bytes.
  - requestBody: unknown
    The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.
Returns Promise<{
body: unknown;
created: boolean;
}>
- status: 200, mediaType: application/json
  
  Returned if the board property is successfully updated.
- status: 201, mediaType: application/json
  
  Returned if the board property is successfully created.
Path
PUT /rest/agile/1.0/board/{boardId}/properties/{propertyKey}

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-properties-propertykey-put

toggleFeatures

toggleFeatures(params): Promise<FeatureResponseBean>
Parameters
- params: {
  boardId: number;
  featureToggleRequestBean: FeatureToggleRequestBean;
  }
  - boardId: number
  - featureToggleRequestBean: FeatureToggleRequestBean
Returns Promise<FeatureResponseBean>
200 response

Path
PUT /rest/agile/1.0/board/{boardId}/features

See
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board#api-rest-agile-1-0-board-boardid-features-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class BoardService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns BoardService

Methods

createBoard

Parameters

boardCreateBean: BoardCreateBean

Example

Returns Promise<Board>

Path

See

deleteBoard

Parameters

boardId: number

Returns Promise<void>

Path

See

deleteBoardProperty

Parameters

boardId: string

propertyKey: string

Returns Promise<void>

Path

See

getAllBoards

Parameters

OptionalaccountIdLocation?: string

Optionalexpand?: string

OptionalfilterId?: number

OptionalincludePrivate?: boolean

OptionalmaxResults?: number

Optionalname?: string

OptionalnegateLocationFiltering?: boolean

OptionalorderBy?: "name" | "-name" | "+name"

OptionalprojectKeyOrId?: string

OptionalprojectLocation?: string

OptionalprojectTypeLocation?: string[]

OptionalstartAt?: number

Optionaltype?: {}

Returns Promise<{ expand?: string; isLast?: boolean; maxResults: number; startAt: number; total?: number; values: Board[]; } & { [key: string]: unknown; }>

Path

See

getAllQuickFilters

Parameters

boardId: number

OptionalmaxResults?: number

OptionalstartAt?: number

Returns Promise<PageBeanQuickFilterBean>

Path

See

getAllSprints

Parameters

boardId: number

OptionalmaxResults?: number

OptionalstartAt?: number

Optionalstate?: {}

Returns Promise<{ expand?: string; isLast?: boolean; maxResults: number; startAt: number; total?: number; values: SprintBean[]; } & { [key: string]: unknown; }>

Path

See

getAllVersions

Parameters

boardId: number

OptionalmaxResults?: number

Optionalreleased?: string

OptionalstartAt?: number

Returns Promise<unknown>

Path

See

getBoard

Parameters

boardId: number

Returns Promise<Board>

`Optional`accountIdLocation?: string

`Optional`expand?: string

`Optional`filterId?: number

`Optional`includePrivate?: boolean

`Optional`maxResults?: number

`Optional`name?: string

`Optional`negateLocationFiltering?: boolean

`Optional`orderBy?: "name" | "-name" | "+name"

`Optional`projectKeyOrId?: string

`Optional`projectLocation?: string

`Optional`projectTypeLocation?: string[]

`Optional`startAt?: number

`Optional`type?: {}

Returns Promise<{
expand?: string;
isLast?: boolean;
maxResults: number;
startAt: number;
total?: number;
values: Board[];
} & {
[key: string]: unknown;
}>

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`state?: {}

Returns Promise<{
expand?: string;
isLast?: boolean;
maxResults: number;
startAt: number;
total?: number;
values: SprintBean[];
} & {
[key: string]: unknown;
}>

`Optional`maxResults?: number

`Optional`released?: string

`Optional`startAt?: number

`Optional`maxResults?: number

`Optional`startAt?: number

Returns Promise<{
isLast?: boolean;
maxResults?: number;
startAt?: number;
total?: number;
values?: BoardFilterBean[];
}>

`Optional`expand?: string

`Optional`fields?: {}[]

`Optional`jql?: string

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`validateQuery?: boolean

`Optional`expand?: string

`Optional`fields?: {}[]

`Optional`jql?: string

`Optional`maxResults?: number

`Optional`startAt?: number

`Optional`validateQuery?: boolean

`Optional`done?: string

`Optional`maxResults?: number

`Optional`startAt?: number