Class IssueCommentsService

This resource represents issue comments. Use it to:

get, create, update, and delete a comment from an issue.
get all comments from issue.
get a list of comments by comment ID.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments

Hierarchy

CommonHttpService
- IssueCommentsService

Index

Constructors

constructor

Methods

addComment deleteComment getComment getComments getCommentsByIds updateComment initialize

Constructors

constructor

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

Methods

addComment

addComment(params): Promise<Comment>

Adds a comment to an issue.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Add comments project permission for the project that the issue containing the comment is in.
If issue-level security is configured, issue-level security permission to view the issue.

Parameters

params: {
    comment: Comment;
    expand?: string;
    issueIdOrKey: string;
}
- comment: Comment
  Example
- Optionalexpand?: string
  Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
- issueIdOrKey: string
  The ID or key of the issue.

Returns Promise<Comment>

Returned if the request is successful.

example:

{
  "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"
  }
}

Path

POST /rest/api/3/issue/{issueIdOrKey}/comment @scopes-current write:jira-work @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:comment:jira, read:avatar:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-post

deleteComment

deleteComment(params): Promise<void>
Deletes a comment.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Parameters
- params: {
  id: string;
  issueIdOrKey: string;
  }
  - id: string
    The ID of the comment.
  - issueIdOrKey: string
    The ID or key of the issue.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/{issueIdOrKey}/comment/{id} @scopes-current write:jira-work @scopes-beta delete:comment:jira, delete:comment.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-delete

getComment

getComment(params): Promise<Comment>

Returns a comment.

This operation can be accessed anonymously.

Permissions required:

Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.

Parameters

params: {
    expand?: string;
    id: string;
    issueIdOrKey: string;
}
- Optionalexpand?: string
  Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
- id: string
  The ID of the comment.
- issueIdOrKey: string
  The ID or key of the issue.

Returns Promise<Comment>

Returned if the request is successful.

example:

{
  "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"
  }
}

Path

GET /rest/api/3/issue/{issueIdOrKey}/comment/{id} @scopes-current read:jira-work @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-get

getComments

getComments(params): Promise<PageOfComments>

Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:

Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.

Parameters

params: {
    expand?: string;
    issueIdOrKey: string;
    maxResults?: number;
    orderBy?: "created" | "-created" | "+created";
    startAt?: number;
}
- Optionalexpand?: string
  Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
- issueIdOrKey: string
  The ID or key of the issue.
- OptionalmaxResults?: number
  The maximum number of items to return per page.
- OptionalorderBy?: "created" | "-created" | "+created"
  Order the results by a field. Accepts created to sort comments by their created date.
- OptionalstartAt?: number
  The index of the first item to return in a page of results (page offset).

Returns Promise<PageOfComments>

Returned if the request is successful.

example:

{
  "comments": [
    {
      "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"
      }
    }
  ],
  "maxResults": 1,
  "startAt": 0,
  "total": 1
}

Path

GET /rest/api/3/issue/{issueIdOrKey}/comment @scopes-current read:jira-work @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:avatar:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-get

getCommentsByIds

getCommentsByIds(params): Promise<PageBeanComment>

Returns a paginated list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:

has Browse projects project permission for the project containing the comment.
If issue-level security is configured, issue-level security permission to view the issue.
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.

Parameters

params: {
expand?: string;
issueCommentListRequestBean: IssueCommentListRequestBean;
}
- Optionalexpand?: string
  Use expand to include additional information about comments in the response. This parameter accepts a comma-separated list. Expand options include:
  - renderedBody Returns the comment body rendered in HTML.
  - properties Returns the comment's properties.
- issueCommentListRequestBean: IssueCommentListRequestBean
  The list of comment IDs.
  
  Example

Returns Promise<PageBeanComment>

Returned if the request is successful.

example:

{
  "isLast": true,
  "maxResults": 1048576,
  "startAt": 0,
  "total": 1,
  "values": [
    {
      "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"
      }
    }
  ]
}

Path

POST /rest/api/3/comment/list @scopes-current read:jira-work @scopes-beta delete:comment.property:jira, read:avatar:jira, read:comment:jira, read:group:jira, read:project-role:jira, read:user:jira, read:comment.property:jira, read:project:jira

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-comment-list-post

updateComment

updateComment(params): Promise<Comment>
Updates a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Parameters
- params: {
      comment: Comment;
      expand?: string;
      id: string;
      issueIdOrKey: string;
      notifyUsers?: boolean;
      overrideEditableFlag?: boolean;
  }
  - comment: Comment
    Example
  - Optionalexpand?: string
    Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.
  - id: string
    The ID of the comment.
  - issueIdOrKey: string
    The ID or key of the issue.
  - OptionalnotifyUsers?: boolean
    Whether users are notified when a comment is updated.
  - OptionaloverrideEditableFlag?: boolean
    Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global permission.
Returns Promise<Comment>
Returned if the request is successful.

example:
```
{
  "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"
  }
}
```
Path
PUT /rest/api/3/issue/{issueIdOrKey}/comment/{id} @scopes-current write:jira-work @scopes-beta read:comment:jira, read:comment.property:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, write:comment:jira, read:avatar:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments#api-rest-api-3-issue-issueidorkey-comment-id-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class IssueCommentsService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueCommentsService

Methods

addComment

Parameters

comment: Comment

Example

Optionalexpand?: string

issueIdOrKey: string

Returns Promise<Comment>

Path

See

deleteComment

Parameters

id: string

issueIdOrKey: string

Returns Promise<void>

Path

See

getComment

Parameters

Optionalexpand?: string

id: string

issueIdOrKey: string

Returns Promise<Comment>

Path

See

getComments

Parameters

Optionalexpand?: string

issueIdOrKey: string

OptionalmaxResults?: number

OptionalorderBy?: "created" | "-created" | "+created"

OptionalstartAt?: number

Returns Promise<PageOfComments>

Path

See

getCommentsByIds

Parameters

Optionalexpand?: string

issueCommentListRequestBean: IssueCommentListRequestBean

Example

Returns Promise<PageBeanComment>

Path

See

updateComment

Parameters

comment: Comment

Example

Optionalexpand?: string

id: string

issueIdOrKey: string

OptionalnotifyUsers?: boolean

OptionaloverrideEditableFlag?: boolean

Returns Promise<Comment>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

`Optional`expand?: string

`Optional`expand?: string

`Optional`expand?: string

`Optional`maxResults?: number

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

`Optional`startAt?: number

`Optional`expand?: string

`Optional`expand?: string

`Optional`notifyUsers?: boolean

`Optional`overrideEditableFlag?: boolean

`Protected` `Static`initialize