7.2.1.13. Issue Comments API

Endpoints

GET	/api/projects/{projectName}/issues/{issueIdentifier}/comments	Get Comments
POST	/api/projects/{projectName}/issues/{issueIdentifier}/comments	Comment an Issue
DELETE	/api/projects/{projectName}/issues/{issueIdentifier}/comments/{id}	Mark a Comment as deleted

GET /api/projects/{projectName}/issues/{issueIdentifier}/comments

Get Comments.

Queries comments made on the issue identified by {issueIdentifier}

In the Python API this functionality is provided by axivion.dashboard.Project.get_issue_comments().

Status Codes:

• 200 OK –

  Body Type: IssueCommentList

  The list of comments in chronological order.

POST /api/projects/{projectName}/issues/{issueIdentifier}/comments

Comment an Issue.

In the Python API this functionality is provided by axivion.dashboard.Project.comment_issue().

Request Body:

• Body Type: CommentRequest

Status Codes:

• 204 No Content – Successful response

DELETE /api/projects/{projectName}/issues/{issueIdentifier}/comments/{id}

Mark a Comment as deleted.

The id is obtained by querying the comment list, see above. Only the comments that you are allowed to delete will have the string-field commentDeletionId set.

In the Python API this functionality is provided by axivion.dashboard.Project.delete_issue_comment().

Parameters:

• projectName – path

  The project name

• issueIdentifier – path

  The ID of the Issue, e.g. MV26 or SV2

• id – path

  The id of the comment to delete

Status Codes:

• 204 No Content – Successful response

Types

IssueCommentList	Response when listing comments of an issue
IssueComment	Describes an issue comment
CommentRequest	Describes a Comment Request

IssueCommentList

Response when listing comments of an issue.

Properties:

• comments (array) Element Type: IssueComment. Comments in chronological order

IssueComment

Describes an issue comment.

Properties:

• username (string) The loginname of the user that created the comment.

• userDisplayName (string) The recommended display name of the user that wrote the comment.

• date (string) The Date when the comment was created as a ISO8601-parseable string.

• displayDate (string) The Date when the comment was created for UI-display.

  It is formatted as a human-readable string relative to query time, e.g. 2 minutes ago.

• text (string) The comment text.

• html (string) Since 7.6.0. The linkified comment text.

• commentDeletionId (string) The id for comment deletion.

  When the requesting user is allowed to delete the comment, contains an id that can be used to mark the comment as deleted using another API. This is never set when the Comment is returned as the result of an Issue-List query.

CommentRequest

Describes a Comment Request.

Properties:

• text (string) The comment text