Interface UpdateComment

A comment.

interface UpdateComment {
    author?: Version2.Version2Models.UserDetails;
    comment?: string;
    created?: string;
    expand?: string | string[] | ["renderedBody"];
    id: string;
    issueIdOrKey: string;
    jsdAuthorCanSeeRequest?: boolean;
    jsdPublic?: boolean;
    notifyUsers?: boolean;
    overrideEditableFlag?: boolean;
    properties?: Version2.Version2Models.EntityProperty[];
    renderedBody?: string;
    self?: string;
    updateAuthor?: Version2.Version2Models.UserDetails;
    updated?: string;
    visibility?: Version2.Version2Models.Visibility;
}

Hierarchy (view full)

Properties

author? comment? created? expand? id issueIdOrKey jsdAuthorCanSeeRequest? jsdPublic? notifyUsers? overrideEditableFlag? properties? renderedBody? self? updateAuthor? updated? visibility?

Properties

Optional author

author?: Version2.Version2Models.UserDetails

Optional comment

comment?: string

The comment text.

Optional created

created?: string

The date and time at which the comment was created.

Optional expand

expand?: string | string[] | ["renderedBody"]

Use expand to include additional information about comments in the response. This parameter accepts renderedBody, which returns the comment body rendered in HTML.

id

id: string

The ID of the comment.

issueIdOrKey

issueIdOrKey: string

The ID or key of the issue.

Optional jsdAuthorCanSeeRequest

jsdAuthorCanSeeRequest?: boolean

Whether the comment was added from an email sent by a person who is not part of the issue. See Allow external emails to be added as comments on issuesfor information on setting up this feature.

Optional jsdPublic

jsdPublic?: boolean

Whether the comment is visible in Jira Service Desk. Defaults to true when comments are created in the Jira Cloud Platform. This includes when the site doesn't use Jira Service Desk or the project isn't a Jira Service Desk project and, therefore, there is no Jira Service Desk for the issue to be visible on. To create a comment with its visibility in Jira Service Desk set to false, use the Jira Service Desk REST API Create request comment operation.

Optional notifyUsers

notifyUsers?: boolean

Whether users are notified when a comment is updated.

Optional overrideEditableFlag

overrideEditableFlag?: 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.

Optional properties

properties?: Version2.Version2Models.EntityProperty[]

A list of comment properties. Optional on create and update.

Optional renderedBody

renderedBody?: string

The rendered version of the comment.

Optional self

self?: string

The URL of the comment.

Optional updateAuthor

updateAuthor?: Version2.Version2Models.UserDetails

Optional updated

updated?: string

The date and time at which the comment was updated last.

Optional visibility

visibility?: Version2.Version2Models.Visibility

Settings

Member Visibility

Theme

On This Page

authorcommentcreatedexpandidissueIdOrKeyjsdAuthorCanSeeRequestjsdPublicnotifyUsersoverrideEditableFlagpropertiesrenderedBodyselfupdateAuthorupdatedvisibility