comment

delete-property

Delete comment property

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.

DELETE /rest/api/3/comment/{commentId}/properties/{propertyKey}

Flag	Type	Required	Description
--commentId	string	Yes	The ID of the comment.
--propertyKey	string	Yes	The key of the property.

Example:

jr comment delete-property --commentId <commentId> --propertyKey <propertyKey>

get-by-ids

Get comments by IDs

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.

POST /rest/api/3/comment/list

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--expand	string	No	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. |

Example:

jr comment get-by-ids

get-property

Get comment property

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.

GET /rest/api/3/comment/{commentId}/properties/{propertyKey}

Flag	Type	Required	Description
--commentId	string	Yes	The ID of the comment.
--propertyKey	string	Yes	The key of the property.

Example:

jr comment get-property --commentId <commentId> --propertyKey <propertyKey>

get-property-keys

Get comment property keys

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.

GET /rest/api/3/comment/{commentId}/properties

Flag	Type	Required	Description
--commentId	string	Yes	The ID of the comment.

Example:

jr comment get-property-keys --commentId <commentId>

set-property

Set comment property

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.

PUT /rest/api/3/comment/{commentId}/properties/{propertyKey}

Flag	Type	Required	Description
--body	string	No	request body (JSON string, @file, or - for stdin)
--commentId	string	Yes	The ID of the comment.
--propertyKey	string	Yes	The key of the property. The maximum length is 255 characters.

Example:

jr comment set-property --commentId <commentId> --propertyKey <propertyKey>