Class IssueCommentPropertiesService

This resource represents issue comment properties, which provides for storing custom data against an issue comment. Use is to get, set, and delete issue comment properties as well as obtain the keys of all properties on a comment. Comment properties are a type of entity property.

See

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

Hierarchy

CommonHttpService
- IssueCommentPropertiesService

Index

Constructors

constructor

Methods

deleteCommentProperty getCommentProperty getCommentPropertyKeys setCommentProperty initialize

Constructors

constructor

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

Methods

deleteCommentProperty

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

Permissions required: either of:
- Edit All Comments project permission to delete a property from any comment.
- Edit Own Comments project permission to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Parameters
- params: {
  commentId: string;
  propertyKey: string;
  }
  - commentId: string
    The ID of the comment.
  - propertyKey: string
    The key of the property.
Returns Promise<void>
Path
DELETE /rest/api/3/comment/{commentId}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta delete:comment.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties#api-rest-api-3-comment-commentid-properties-propertykey-delete

getCommentProperty

getCommentProperty(params): Promise<EntityProperty>
Returns the value of a comment property.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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: {
  commentId: string;
  propertyKey: string;
  }
  - commentId: string
    The ID of the comment.
  - propertyKey: string
    The key of the property.
Returns Promise<EntityProperty>
Returned if the request is successful.

example:
```
{
  "key": "issue.support",
  "value": {
    "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
    "system.support.time": "1m"
  }
}
```
Path
GET /rest/api/3/comment/{commentId}/properties/{propertyKey} @scopes-current read:jira-work @scopes-beta read:comment.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties#api-rest-api-3-comment-commentid-properties-propertykey-get

getCommentPropertyKeys

getCommentPropertyKeys(params): Promise<PropertyKeys>
Returns the keys of all the properties of a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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: {
  commentId: string;
  }
  - commentId: string
    The ID of the comment.
Returns Promise<PropertyKeys>
Returned if the request is successful.

example:
```
{
  "keys": [
    {
      "key": "issue.support",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
    }
  ]
}
```
Path
GET /rest/api/3/comment/{commentId}/properties @scopes-current read:jira-work @scopes-beta read:comment.property:jira

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

setCommentProperty

setCommentProperty(params): Promise<{
body: unknown;
created: boolean;
}>
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: either of:
- Edit All Comments project permission to create or update the value of a property on any comment.
- Edit Own Comments project permission to create or update the value of a property on a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Parameters
- params: {
      commentId: string;
      propertyKey: string;
      requestBody: unknown;
  }
  - commentId: string
    The ID of the comment.
  - propertyKey: string
    The key of the property. The maximum length is 255 characters.
  - 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 comment property is updated.
- status: 201, mediaType: application/json
  
  Returned if the comment property is created.
Path
PUT /rest/api/3/comment/{commentId}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta write:comment.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comment-properties#api-rest-api-3-comment-commentid-properties-propertykey-put

`Protected` `Static`initialize

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

Returns void
Overrides CommonHttpService.initialize

Class IssueCommentPropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueCommentPropertiesService

Methods

deleteCommentProperty

Parameters

commentId: string

propertyKey: string

Returns Promise<void>

Path

See

getCommentProperty

Parameters

commentId: string

propertyKey: string

Returns Promise<EntityProperty>

Path

See

getCommentPropertyKeys

Parameters

commentId: string

Returns Promise<PropertyKeys>

Path

See

setCommentProperty

Parameters

commentId: string

propertyKey: string

requestBody: unknown

Returns Promise<{ body: unknown; created: boolean; }>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

Returns Promise<{
body: unknown;
created: boolean;
}>

`Protected` `Static`initialize